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

shopline_sdk/models/merchant_kyc.py

@@ -0,0 +1,24 @@
+"""Shopline API 数据模型 - MerchantKyc"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .corporate_info import CorporateInfo
+from .individual_info import IndividualInfo
+
+
+class MerchantKyc(BaseModel):
+    type: Optional[Literal['individual', 'corporate']] = None
+    """entity type 實體類型"""
+    bank_code: Optional[str] = None
+    """Bank code 銀行代碼"""
+    bank_account: Optional[str] = None
+    """Bank account 銀行帳戶"""
+    bank_account_name: Optional[str] = None
+    """Bank account holder name 銀行戶名"""
+    individual_info: Optional[Union[IndividualInfo, Any]] = None
+    """Information for individual entities 個人資料，type為corporate時為null"""
+    corporate_info: Optional[Union[CorporateInfo, Any]] = None
+    """Information for corporate entities 公司資料，type為individual時為null"""

shopline_sdk/models/merchant_tax.py

@@ -0,0 +1,50 @@
+"""Shopline API 数据模型 - MerchantTax"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .tax_region import TaxRegion
+
+
+
+class SalesConfig(BaseModel):
+    """Configuration model for sales"""
+    general: Optional[TaxRegion] = None
+    details: Optional[List[TaxRegion]] = None
+
+
+class DeliveryConfig(BaseModel):
+    """Configuration model for delivery"""
+    general: Optional[TaxRegion] = None
+    details: Optional[List[TaxRegion]] = None
+
+
+class Service_ChargeConfig(BaseModel):
+    """Configuration model for service_charge"""
+    general: Optional[TaxRegion] = None
+    details: Optional[List[TaxRegion]] = None
+
+class MerchantTax(BaseModel):
+    id: Optional[str] = None
+    """Tax ID 稅金設定ID"""
+    name: Optional[str] = None
+    """Tax Name 稅金名稱"""
+    merchant_id: Optional[str] = None
+    """Merchant ID 商户ID"""
+    country: Optional[str] = None
+    """country code 國家代碼"""
+    is_default_rates: Optional[bool] = None
+    """is use default rates or not 是否是預設稅率"""
+    enable_inclusive: Optional[bool] = None
+    """is enable inclusive or not 商品是否含稅"""
+    allow_inclusive_tax: Optional[bool] = None
+    """is allow to enable inclusive tax or not 是否允許商品含稅"""
+    service_charge_taxable: Optional[bool] = None
+    """is service charge taxable or not  服務稅是否應稅"""
+    emoji_flag: Optional[str] = None
+    """emoji of country flag 國旗emoji"""
+    sales: Optional[SalesConfig] = None
+    delivery: Optional[DeliveryConfig] = None
+    service_charge: Optional[Service_ChargeConfig] = None

shopline_sdk/models/metafield_definition.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - MetafieldDefinition"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .metafield_value import MetafieldValue
+
+
+class MetafieldDefinition(BaseModel):
+    id: Optional[str] = None
+    """Metafield definition ID"""
+    namespace: Optional[str] = None
+    key: Optional[str] = None
+    name: Optional[str] = None
+    """Name"""
+    description: Optional[str] = None
+    """description"""
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    merchant_id: Optional[str] = None
+    """Merchant ID"""
+    resource_type: Optional[Literal['product', 'merchant', 'customer', 'order', 'order_item', 'cart_item']] = None
+    """Resource type of the metafield definition"""
+    metafield_type: Optional[Literal['merchant', 'app']] = None
+    """Type of metafield definition"""
+    created_at: Optional[str] = None
+    updated_at: Optional[str] = None

shopline_sdk/models/metafield_value.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - MetafieldValue"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class MetafieldValue(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"""
+    resource_type: Optional[Literal['merchant', 'customer', 'product', 'order', 'order_item', 'cart_item']] = None
+    """Resource Type"""
+    merchant_id: Optional[str] = None
+    """Merchant ID"""

shopline_sdk/models/money.py

@@ -0,0 +1,13 @@
+"""Shopline API 数据模型 - Money"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Money(BaseModel):
+    cents: Optional[int] = None
+    currency_symbol: Optional[str] = None
+    currency_iso: Optional[str] = None
+    label: Optional[str] = None
+    dollars: Optional[float] = None

shopline_sdk/models/multipass_linking.py

@@ -0,0 +1,22 @@
+"""Shopline API 数据模型 - MultipassLinking"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class MultipassLinking(BaseModel):
+    customer_id: Optional[str] = None
+    """Unique ID of customer"""
+    sub: Optional[str] = None
+    """Identifier given in multipass login token payload"""
+    status: Optional[str] = None
+    """status of linking, active means sub is valid for multipass login"""
+    merchant_id: Optional[str] = None
+    """Unique ID of merchant"""
+    app_id: Optional[str] = None
+    """Unique ID from app token payload"""
+    updated_at: Optional[str] = None
+    """Updated time 更新時間"""
+    created_at: Optional[str] = None
+    """Created time 建立時間"""

shopline_sdk/models/multipass_linkings.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - MultipassLinkings"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .multipass_linking import MultipassLinking
+
+
+class MultipassLinkings(BaseModel):
+    result: Optional[str] = None
+    """operation result"""
+    linkings: Optional[List[MultipassLinking]] = None
+    next: Optional[str] = None
+    """for pagination on next call, return items since this ID"""

shopline_sdk/models/multipass_secret.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - MultipassSecret"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class MultipassSecret(BaseModel):
+    merchant_id: Optional[str] = None
+    """Merchant ID"""
+    app_id: Optional[str] = None
+    """App ID (nullable)"""
+    secret: Optional[str] = None
+    """Multipass Secret"""
+    status: Optional[Literal['active', 'draft']] = None
+    """Secret Status - active - draft (inactive)"""
+    updated_at: Optional[str] = None
+    """Secret last updated time"""
+    created_at: Optional[str] = None
+    """Secret created time"""

shopline_sdk/models/net_amount_analytics.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - NetAmountAnalytics"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .analytics import Analytics
+from .money import Money
+
+
+
+class MetadataConfig(BaseModel):
+    """Configuration model for metadata"""
+    total: Optional[Money] = None
+
+
+class RecordsItem(BaseModel):
+    """Item model for records"""
+    label: Optional[str] = None
+    """Datetime of the data point 時間"""
+    value: Optional[Money] = None
+
+class NetAmountAnalytics(BaseModel):
+    start_date: Optional[str] = None
+    end_date: Optional[str] = None
+    metadata: Optional[MetadataConfig] = None
+    records: Optional[List[RecordsItem]] = None

shopline_sdk/models/net_orders_analytics.py

@@ -0,0 +1,29 @@
+"""Shopline API 数据模型 - NetOrdersAnalytics"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .analytics import Analytics
+
+
+
+class MetadataConfig(BaseModel):
+    """Configuration model for metadata"""
+    total: Optional[float] = None
+    """Net number of orders 訂單總量"""
+
+
+class RecordsItem(BaseModel):
+    """Item model for records"""
+    label: Optional[str] = None
+    """Datetime of the data point 時間"""
+    value: Optional[int] = None
+    """Net number of orders 訂單量"""
+
+class NetOrdersAnalytics(BaseModel):
+    start_date: Optional[str] = None
+    end_date: Optional[str] = None
+    metadata: Optional[MetadataConfig] = None
+    records: Optional[List[RecordsItem]] = None

shopline_sdk/models/not_found_error.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - NotFoundError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class NotFoundError(BaseModel):
+    message: Optional[str] = None
+    code: Optional[str] = None
+    extras: Optional[Dict[str, Any]] = None
+    """Optional, Extra information about the error"""

shopline_sdk/models/order.py

@@ -0,0 +1,218 @@
+"""Shopline API 数据模型 - Order"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .order_agent import OrderAgent
+from .order_campaign_item import OrderCampaignItem
+from .order_customer_info import OrderCustomerInfo
+from .order_delivery import OrderDelivery
+from .order_delivery_address import OrderDeliveryAddress
+from .order_delivery_data import OrderDeliveryData
+from .order_invoice import OrderInvoice
+from .order_item import OrderItem
+from .order_payment import OrderPayment
+from .order_promotion_item import OrderPromotionItem
+from .order_source import OrderSource
+from .utm_data import UtmData
+
+
+
+class InvoicesItem(BaseModel):
+    """Item model for invoices"""
+    tax_id: Optional[str] = None
+    mailing_address: Optional[str] = None
+    invoice_type: Optional[Literal['0', '1', '2']] = None
+    buyer_name: Optional[str] = None
+    carrier_type: Optional[Literal['0', '1', '2']] = None
+    carrier_number: Optional[str] = None
+    n_p_o_b_a_n: Optional[str] = None
+    invoice_tax_type: Optional[Literal['1', '2', '5']] = None
+    invoice_number: Optional[str] = None
+    invoice_status: Optional[Literal['active', 'cancel']] = None
+    invoice_date: Optional[str] = None
+
+
+class Order_CommentsItem(BaseModel):
+    """Item model for order_comments"""
+    owner_type: Optional[Literal['Merchant', 'User']] = None
+    value: Optional[str] = None
+    time: Optional[str] = None
+
+
+class Order_NotesItem(BaseModel):
+    """Item model for order_notes"""
+    owner_type: Optional[Literal['Merchant', 'User']] = None
+    value: Optional[str] = None
+    time: Optional[str] = None
+
+
+class ChannelConfig(BaseModel):
+    """Configuration model for channel"""
+    created_by_channel_id: Optional[str] = None
+    created_by_channel_name: Optional[Dict[str, Any]] = None
+
+
+class Applied_Tax_InfoConfig(BaseModel):
+    """Configuration model for applied_tax_info"""
+    sales: Optional[Dict[str, Any]] = None
+    delivery: Optional[Dict[str, Any]] = None
+
+
+class Auto_Reward_Credit_SummaryConfig(BaseModel):
+    """Configuration model for auto_reward_credit_summary"""
+    auto_reward_rule_id: Optional[str] = None
+    accumulated_type: Optional[str] = None
+    is_accumulated: Optional[bool] = None
+    credit_threshold: Optional[str] = None
+    credit_value: Optional[str] = None
+    triggered: Optional[bool] = None
+    calculate_credit_value: Optional[str] = None
+    auto_reward_balance: Optional[str] = None
+
+
+class Member_Point_SummaryConfig(BaseModel):
+    """Configuration model for member_point_summary"""
+    pending_days: Optional[int] = None
+    earned_points: Optional[int] = None
+    order_created_by: Optional[str] = None
+    order_type: Optional[str] = None
+
+
+class Payment_SlipsItem(BaseModel):
+    """Item model for payment_slips"""
+    text: Optional[str] = None
+    owner_id: Optional[str] = None
+    trackable_id: Optional[str] = None
+    trackable_type: Optional[str] = None
+    is_private: Optional[bool] = None
+    is_last: Optional[bool] = None
+    owner_type: Optional[str] = None
+    custom_data: Optional[Dict[str, Any]] = None
+
+
+class Order_Items_Stock_TagItem(BaseModel):
+    """Item model for order_items_stock_tag"""
+    product_id: Optional[str] = None
+    """ID of the product"""
+    sku_id: Optional[str] = None
+    """ID of the SKU"""
+    order_item_id: Optional[str] = None
+    """ID of the order item"""
+    stock_tag: Optional[Literal['REDUCE_FAILED', 'INCREASE_FAILED']] = None
+    """Stock tag for the order item"""
+
+class Order(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 已取消    POS 訂單 Status allows:  confirmed 已確認  completed 已完成  cancelled 已取消"""
+    is_guest_checkout: Optional[bool] = None
+    """是否為訪客結帳"""
+    order_remarks: Optional[str] = None
+    """Order Remarks 訂單備註"""
+    order_payment: Optional[OrderPayment] = None
+    order_delivery: Optional[OrderDelivery] = None
+    delivery_address: Optional[OrderDeliveryAddress] = None
+    delivery_data: Optional[OrderDeliveryData] = None
+    customer_id: Optional[str] = None
+    """Cutomer ID 顧客ID"""
+    customer_name: Optional[str] = None
+    """Customer's Name 顧客姓名"""
+    customer_email: Optional[str] = None
+    """Customer's Email 顧客Email"""
+    customer_phone: Optional[str] = None
+    """Customer's Phone 顧客電話"""
+    customer_phone_country_code: Optional[str] = None
+    """Customer's Phone Country Code 顧客電話國碼"""
+    customer_info: Optional[OrderCustomerInfo] = None
+    currency_iso: Optional[str] = None
+    """Currency ISO (ISO-4217) ISO 4217 貨幣代碼"""
+    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[int] = None
+    """Discounted by the points used 會員點數折抵金額"""
+    invoice: Optional[OrderInvoice] = None
+    invoices: Optional[List[InvoicesItem]] = None
+    """Invoices Info 發票資訊（包含 EC、POS）"""
+    subtotal_items: Optional[OrderItem] = None
+    promotion_items: Optional[OrderPromotionItem] = None
+    custom_data: Optional[List[Dict[str, Any]]] = None
+    """Customized Order Fields 客製化欄位 - *欲使用此欄位請先至商店後台>訂單設定>自訂訂單欄位 進行設定"""
+    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"""
+    agent: Optional[OrderAgent] = None
+    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"""
+    edited_at: Optional[str] = None
+    """Order Edit Time 訂單修改日期 *UTC Time"""
+    completed_at: Optional[str] = None
+    """Order Completed Time 訂單完成日期 *UTC Time"""
+    skip_fulfillment: Optional[bool] = None
+    """Is order skipping fulfillment? 訂單是否略過“扣減庫存”"""
+    utm_data: Optional[UtmData] = None
+    ga_tracked: Optional[bool] = None
+    """Is tracked by GA? 是否使用GA追蹤"""
+    order_comments: Optional[List[Order_CommentsItem]] = None
+    """Customer Comments 顧客通訊內容"""
+    order_notes: Optional[List[Order_NotesItem]] = None
+    """Order Notes 訂單備註"""
+    created_by: Optional[Literal['openapi', 'admin', 'shop', 'shop_crm', 'pos', 'sc', 'mc', 'import']] = None
+    """Channel that created the order 建立訂單的渠道"""
+    agent_id: Optional[str] = None
+    """Agent ID that created the order 代理建立訂單的操作者 ID  Only provided when include_fields contains 'agent_id'  僅於include_fields傳入 'agent_id' 時提供"""
+    affiliate_data: Optional[Dict[str, Any]] = None
+    """Affiliate Data 聯屬網絡營銷數據"""
+    default_warehouse_id: Optional[str] = None
+    """The default warehouse ID of the created_by_channel of the order. If the created_by_channel is blank, this field will be the default warehouse ID of the online channel.  訂單 created_by_channel 預設的倉庫 ID。如果 created_by_channel 為空，則此欄位將是 online channel 的 default_warehouse_id。"""
+    channel: Optional[ChannelConfig] = None
+    """Channel 渠道"""
+    applied_tax_info: Optional[Applied_Tax_InfoConfig] = None
+    """Applied Tax Info 稅務信息"""
+    auto_reward_credit_summary: Optional[Auto_Reward_Credit_SummaryConfig] = None
+    """訂單回饋購物金資訊"""
+    member_point_summary: Optional[Member_Point_SummaryConfig] = None
+    """訂單回饋點數資訊"""
+    payment_slips: Optional[List[Payment_SlipsItem]] = None
+    """Payment Slips 付款單"""
+    type: Optional[Literal['general', 'preorder', 'return', 'exchange']] = None
+    """Order type 訂單類型  The field is only available for POS orders (created_by: pos)  此欄位僅適用於POS訂單 (created_by: pos) - general: 一般訂單  - preorder: 預訂單  - return: 退貨單  - exchange: 換貨單"""
+    affiliate_campaign: Optional[OrderCampaignItem] = None
+    order_source: Optional[OrderSource] = None
+    tags: Optional[List[str]] = None
+    """Order tags 商品標籤"""
+    inclusive_tax_info: Optional[Dict[str, Any]] = None
+    """inclusive tax information 內含稅信息"""
+    product_subscription_period: Optional[int] = None
+    """Product Subscription Period 定期購期數"""
+    allow_customer_cancel: Optional[bool] = None
+    """Allow Customer Cancel 允許顧客取消訂單"""
+    order_items_stock_tag: Optional[List[Order_Items_Stock_TagItem]] = None
+    """Order items stock tag to indicate increasing or reducing stock failed  If there is no stock error, the field value will be null  Only provided when order_decoupling_product_revamp key is enabled  訂單商品庫存標籤，用來標示庫存增加或減少失敗  若沒有庫存錯誤，則此欄位值為 null  僅於order_decoupling_product_revamp key啟用才會顯示"""

shopline_sdk/models/order_action_log.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - OrderActionLog"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class OrderActionLog(BaseModel):
+    key: Optional[str] = None
+    data: Optional[Dict[str, Any]] = None
+    """data have mutiple ways to be presented according to its action log key.   根據key的不同，data的格式表達也會完全不一樣。"""
+    created_at: Optional[str] = None
+    performer_name: Optional[str] = None
+    performer_type: Optional[str] = None
+    performer_id: Optional[str] = None
+    performing_application_id: Optional[str] = None

shopline_sdk/models/order_action_logs.py

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

shopline_sdk/models/order_agent.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - OrderAgent"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class OrderAgent(BaseModel):
+    email: Optional[str] = None
+    """Email of the agent 員工電郵"""
+    name: Optional[str] = None
+    """Name of the agent 員工名稱"""
+    phone: Optional[str] = None
+    """Phone of the agent 員工電話號碼"""
+    status: Optional[Literal['active', 'removed']] = None
+    """Status of the agent 員工狀態"""

shopline_sdk/models/order_campaign_item.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - OrderCampaignItem"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .translatable import Translatable
+
+
+class OrderCampaignItem(BaseModel):
+    id: Optional[str] = None
+    """Order Campaign Item ID 訂單推薦活動ID"""
+    name_translations: Optional[Translatable] = None
+    type: Optional[Literal['affiliate_referral', 'member_referral']] = None
+    """Campaign Type 推薦活動類型"""
+    reward_type: Optional[Literal['percentage', 'amount']] = None
+    """Campaign Reward Type 推薦活動獎勵類型"""
+    reward_value: Optional[Money] = None
+    campaign_data: Optional[Dict[str, Any]] = None
+    """Campaign Data 推薦活動參數"""
+    campaign_id: Optional[str] = None
+    """Campaign ID 推薦活動ID"""
+    order_id: Optional[str] = None
+    """Order ID 訂單ID"""
+    bonus_balance: Optional[Money] = None

shopline_sdk/models/order_comment.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - OrderComment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .media import Media
+
+
+class OrderComment(BaseModel):
+    id: Optional[str] = None
+    """ID of the comment 訂單通訊的id"""
+    created_at: Optional[str] = None
+    """Created Time 創建時間"""
+    updated_at: Optional[str] = None
+    """Updated Time 更新時間"""
+    text: Optional[str] = None
+    """The message of the comment 該訂單通訊的訊息內容"""
+    owner_id: Optional[str] = None
+    """The owner id of the comment 該訂單通訊發出者的id"""
+    owner_type: Optional[str] = None
+    """The owner id of the comment 該訂單通訊發出者的類型"""
+    trackable_id: Optional[str] = None
+    trackable_type: Optional[str] = None
+    is_private: Optional[bool] = None
+    """The type of the comment. If true, the message can only be viewed by the shop admin.  If false, the message can also be viewed by the customer.  訂單通訊的類型。若為true，則該訂單通訊只能被網店管理查看。  若為false，則顧客也可查看。"""
+    media: Optional[Media] = None

shopline_sdk/models/order_conversation.py

@@ -0,0 +1,39 @@
+"""Shopline API 数据模型 - OrderConversation"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Last_MessageConfig(BaseModel):
+    """Configuration model for last_message"""
+    id: Optional[str] = None
+    """Conversation ID 對話 ID"""
+    sender_id: Optional[Any] = None
+    """Sender ID 留言發送方 ID"""
+    sender_type: Optional[Any] = None
+    """Sender Type 留言發送方"""
+    created_at: Optional[str] = None
+    """Created At 建立時間"""
+    value: Optional[str] = None
+    """Content 對話內容"""
+    type: Optional[Literal['text', 'image']] = None
+    """Conversation Type 對話類別"""
+
+class OrderConversation(BaseModel):
+    id: Optional[str] = None
+    """Conversation ID 訊息 ID"""
+    type: Optional[Literal['shop_messages', 'order_messages']] = None
+    """Conversation Type 訊息平台"""
+    customer_id: Optional[str] = None
+    """Customer ID 客戶 ID"""
+    order_number: Optional[str] = None
+    """Order Number 訂單號碼"""
+    system_order_number: Optional[str] = None
+    """系统生成的訂單號 system order number"""
+    merchant_order_number: Optional[str] = None
+    """店家自定義訂單號 (會根據rollout_key選擇用哪個order_number)"""
+    order_id: Optional[str] = None
+    """Order ID 訂單ID"""
+    last_message: Optional[Last_MessageConfig] = None

shopline_sdk/models/order_conversations.py

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