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

shopline_sdk/models/job.py

@@ -0,0 +1,48 @@
+"""Shopline API 数据模型 - Job"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Ref_DataConfig(BaseModel):
+    """Configuration model for ref_data"""
+    result_file: Optional[str] = None
+    """URL of file contains the job result"""
+
+class Job(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    name: Optional[str] = None
+    """Name of job"""
+    type: Optional[str] = None
+    """Related resource of the job"""
+    status: Optional[Literal['pending', 'in_progress', 'done', 'failed']] = None
+    """Job status"""
+    created_at: Optional[str] = None
+    """Job created time"""
+    start_time: Optional[str] = None
+    """Job started time"""
+    finish_time: Optional[str] = None
+    """Job completed time"""
+    expiry_time: Optional[str] = None
+    """Job expire time"""
+    total_count: Optional[int] = None
+    """Number of data processed in total"""
+    successful_count: Optional[int] = None
+    """Number of data succeed"""
+    failed_count: Optional[int] = None
+    """Number of data failed"""
+    ref_data: Optional[Ref_DataConfig] = None
+    """Job started time"""
+    created_by: Optional[str] = None
+    """Source of job"""
+    performer_name: Optional[str] = None
+    """The name of user performed the job"""
+    performer_type: Optional[str] = None
+    """The type of user performed the job"""
+    performer_id: Optional[str] = None
+    """The ID of user performed the job"""
+    performing_application_id: Optional[str] = None
+    """The ID of application performed the job"""

shopline_sdk/models/jobs.py

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

shopline_sdk/models/layout_sections.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - LayoutSections"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .page_sections import PageSections
+
+
+class LayoutSections(BaseModel):
+    pass

shopline_sdk/models/layouts_setting.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - LayoutsSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .global_section_settings import GlobalSectionSettings
+
+
+class LayoutsSetting(BaseModel):
+    announcement: Optional[GlobalSectionSettings] = None
+    header: Optional[GlobalSectionSettings] = None
+    footer: Optional[GlobalSectionSettings] = None

shopline_sdk/models/limit_exceeded_error.py

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

shopline_sdk/models/link.py

@@ -0,0 +1,39 @@
+"""Shopline API 数据模型 - Link"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+
+class Seo_ImageConfig(BaseModel):
+    """Configuration model for seo_image"""
+    id: Optional[str] = None
+    """Media ID"""
+    url: Optional[str] = None
+    """Media URL"""
+
+class Link(BaseModel):
+    id: Optional[str] = None
+    status: Optional[str] = None
+    type: Optional[str] = None
+    name: Optional[str] = None
+    name_translations: Optional[Translatable] = None
+    value_id: Optional[str] = None
+    url_link: Optional[str] = None
+    key: Optional[str] = None
+    html_target: Optional[str] = None
+    section: Optional[str] = None
+    owner_id: Optional[str] = None
+    parent_id: Optional[str] = None
+    priority: Optional[float] = None
+    children_ids: Optional[List[str]] = None
+    created_at: Optional[str] = None
+    """Created Time 建立時間"""
+    updated_at: Optional[str] = None
+    """Updated Time 更新時間"""
+    seo_image: Optional[Seo_ImageConfig] = None
+    """SEO Image SEO社群預覽圖"""

shopline_sdk/models/lock_inventory.py

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

shopline_sdk/models/lock_inventory_count.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - LockInventoryCount"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class LockInventoryCount(BaseModel):
+    product_id: Optional[str] = None
+    """Product ID. 商品 ID"""
+    locked_inventory_count: Optional[int] = None
+    """Locked inventory count 已鎖定庫存數量"""
+    variations: Optional[Dict[str, Any]] = None
+    """Variations 多規格商品"""

shopline_sdk/models/max_applicable_member_point.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - MaxApplicableMemberPoint"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .member_point_rule import MemberPointRule
+
+
+class MaxApplicableMemberPoint(BaseModel):
+    max_applicable_member_point_redeem_to_cash: Optional[int] = None
+    """The maximum member point the user can apply to the order transfers to dollars"""
+    max_applicable_member_point: Optional[int] = None
+    """The maximum member point the user can apply to the order"""
+    point_redeem_to_cash_rule: Optional[MemberPointRule] = None

shopline_sdk/models/media.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - Media"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class Media(BaseModel):
+    id: Optional[str] = None
+    """Media ID"""
+    alt_translations: Optional[Translatable] = None
+    images: Optional[Dict[str, Any]] = None
+    """Object contains url of image in different dimensions 包含不同大小圖片的連絡"""

shopline_sdk/models/media_upload_error.py

@@ -0,0 +1,10 @@
+"""Shopline API 数据模型 - MediaUploadError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class MediaUploadError(BaseModel):
+    error: Optional[List[str]] = None
+    """A detailed array of messages of the reason of failure"""

shopline_sdk/models/member_point.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - MemberPoint"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class MemberPoint(BaseModel):
+    customer_id: Optional[str] = None
+    """Customer ID"""
+    point_balance: Optional[int] = None
+    """Member Point 現有點數"""
+    remarks: Optional[str] = None
+    """Point Change Reason 點數更動原因"""
+    value: Optional[int] = None
+    """Point 點數"""
+    order_id: Optional[str] = None
+    """Order ID"""
+    order_number: Optional[str] = None
+    """Order Number"""
+    type: Optional[Literal['manual', 'auto_reward', 'expired', 'order_redeemed', 'redeemed_to_cash', 'order_split_revert', 'product_review_reward', 'member_info_reward', 'return_order_revert', 'order_edit_revert']] = None
+    """Member point type 點數種類  ----  manual: 手動增減點數（店家手動發送、取消訂單/退貨訂單回補）  auto_reward: 點數回饋  expired: 點數過期  order_redeemed: 使用點數兌換贈品於訂單  redeemed_to_cash: 使用點數折現於訂單  order_split_revert: 回補點數（來自拆單）  product_review_reward: 商品評價獎賞  member_info_reward: 會員資料獎賞  return_order_revert: 退貨單回補會員點數  order_edit_revert: 訂單編輯回補會員點數"""
+    is_redeem: Optional[bool] = None
+    """Redeemed? 已兌換?"""
+    expire_at: Optional[str] = None
+    """Expiry date, a null value means never expired 到期日期, null 表示不會到期"""
+    created_at: Optional[str] = None
+    """Created Time 點數創建時間"""

shopline_sdk/models/member_point_fulfillment.py

@@ -0,0 +1,23 @@
+"""Shopline API 数据模型 - MemberPointFulfillment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Never_Expire_ItemConfig(BaseModel):
+    """Configuration model for never_expire_item"""
+    total_value: Optional[float] = None
+    """The total value of never expire member points.<br/> 永久有效的會員點數加總"""
+    expire_at: Optional[str] = None
+    """This field will be null because the member point never expire.<br/> 會員點數為永久有效，此欄位為 null"""
+
+class MemberPointFulfillment(BaseModel):
+    limit: Optional[float] = None
+    """To limit how many items will be returned<br/>限制 items 回傳多少筆資料"""
+    remaining_value: Optional[Dict[str, Any]] = None
+    """To return the total remaining value of member point if items count is larger than the limit.<br/> 如果 items 的筆數大於限制，則剩餘未顯示於 items 的點數會加總顯示於此，expire_at 會顯示較快過期的日期"""
+    items: Optional[List[Any]] = None
+    """The list of member point fulfillments which will expire in specific date.<br/> 含有到期日的會員點數列表，最多顯示 limit 參數個數，剩餘會加總並顯示於 remaining_value"""
+    never_expire_item: Optional[Never_Expire_ItemConfig] = None

shopline_sdk/models/member_point_rule.py

@@ -0,0 +1,40 @@
+"""Shopline API 数据模型 - MemberPointRule"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class MemberPointRule(BaseModel):
+    id: Optional[str] = None
+    """Member Point Rule ID<br />會員點數ID"""
+    status: Optional[Literal['active', 'inactive']] = None
+    """Whether the rules is applying<br />規則是否正在生效"""
+    unit_price: Optional[int] = None
+    """The amount of purchase to earn a unit of points.<br /> This field will be null if the rule_type is not "earn_from_order."<br /> 賺取一個單位的點數所需的購買金額<br /> 如rule_type不是"earn_from_order"，此欄會是null"""
+    points_per_unit: Optional[int] = None
+    """The amount of points earned by a unit of unit_price.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 一個單位的unit_price能夠賺取的點數 如rule_type不是"earn_from_order"，此欄會是null"""
+    points_expire_day: Optional[int] = None
+    """The expiry date of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期日，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null"""
+    points_expire_month: Optional[int] = None
+    """The expiry month of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期月份，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null"""
+    pending_days: Optional[int] = None
+    """The number of days after delivery received (Arrived/ Collected) will the system automatically assign the point to customer.<br /> This field will be null if the rule_type is not "earn_from_order".＜br /> 顧客訂單轉變為 已取貨 / 已到達(宅配) 後幾天自動發送點數<br /> 如rule_type不是"earn_from_order"，此欄會是null"""
+    rule_type: Optional[Literal['earn_from_order', 'max_percentage_per_order', 'max_amount_per_order']] = None
+    """Define the types of rules that the current object is representing.<br /> 定義這個物件正在表示的規則類別"""
+    remarks_translations: Optional[Translatable] = None
+    membership_tier_id: Optional[str] = None
+    """The id of membership_tier."""
+    unit_point: Optional[int] = None
+    """The amount of points needed to redeem a unit of discount.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 兌換一個單位的折扣所需的點數<br /> 如rule_type是"earn_from_order"，此欄會是null"""
+    price_per_unit: Optional[int] = None
+    """The amount of discount per unit of points.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 一個單位的點數兌換到的折扣<br /> 如rule_type是"earn_from_order"，此欄會是null"""
+    point_value: Optional[int] = None
+    """The price to apply point discount.<br /> It will be -1 if there is no constraint on applying discount.<br /> This field will be -1 if the rule_type is "earn_from_order".<br /> 可以使用折扣的價錢<br /> 如沒有設置使用折扣的價格，此欄會是-1<br /> 如rule_type是"earn_from_order"，此欄會是-1"""
+    apply_threshold: Optional[int] = None
+    """Maximum amount of point discount could be applied, the metric depends on the rule_type.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 可使用的最高折扣額，此欄的單位會因應rule_type而改變<br /> 如rule_type是"earn_from_order"，此欄會是null"""
+    available_platforms: Optional[List[str]] = None
+    """Available platforms.<br />此規則生效的平台"""

shopline_sdk/models/member_point_rules.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - MemberPointRules"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .member_point_rule import MemberPointRule
+
+
+class MemberPointRules(BaseModel):
+    pass

shopline_sdk/models/member_points.py

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

shopline_sdk/models/member_registration_analytics.py

@@ -0,0 +1,29 @@
+"""Shopline API 数据模型 - MemberRegistrationAnalytics"""
+
+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
+    """Total number of member registration 新增會員總數"""
+
+
+class RecordsItem(BaseModel):
+    """Item model for records"""
+    label: Optional[str] = None
+    """Datetime of the data point 時間"""
+    value: Optional[int] = None
+    """Number of member registration 新增會員數"""
+
+class MemberRegistrationAnalytics(BaseModel):
+    start_date: Optional[str] = None
+    end_date: Optional[str] = None
+    metadata: Optional[MetadataConfig] = None
+    records: Optional[List[RecordsItem]] = None

shopline_sdk/models/membership_info.py

@@ -0,0 +1,56 @@
+"""Shopline API 数据模型 - MembershipInfo"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .membership_tier_rule import MembershipTierRule
+from .translatable import Translatable
+
+
+
+class Membership_TierConfig(BaseModel):
+    """Configuration model for membership_tier"""
+    id: Optional[str] = Field(default=None, alias="_id")
+    """Membership tier's ID 會員等級ID"""
+    level: Optional[int] = None
+    """Level of Current Membership Tier 等級高低"""
+    name_translations: Optional[Translatable] = None
+    merchant_id: Optional[str] = None
+    """merchant ID"""
+    exclusive_product_count: Optional[int] = None
+    """Number of exlcusive products in this membership tier  這個會員級別不能購買的產品數目"""
+    promotion_count: Optional[int] = None
+    """Number of promotions in this membership tier  這個會員級別的優惠數目"""
+    valid_period: Optional[Dict[str, Any]] = None
+    """Valid period of this membership tier  這個會員級別的有效時段"""
+    membership_tier_rules: Optional[List[MembershipTierRule]] = None
+    created_at: Optional[str] = None
+    updated_at: Optional[str] = None
+
+
+class Membership_Tier_GapConfig(BaseModel):
+    """Configuration model for membership_tier_gap"""
+    next_tier: Optional[Dict[str, Any]] = None
+    """Membership Tier Data 顧客會員等級"""
+    next_discount: Optional[float] = None
+    """The discount of next membership tier<br />下一個會員等級的折扣優惠"""
+    user_spending: Optional[float] = None
+    """The amount used to determine if a member meets the upgrade criteria, based on the "Membership Upgrade Condition" in the SHOPLINE Admin:  - For "Single Purchase," returns the highest order amount that meets the threshold   during the membership period, or 0 if none meet the threshold.  - For "Purchase within specified period," returns the total spending within that period.  Returns null if the member is already at the highest tier.    用於判斷會員是否符合升級條件的消費金額，依據 Admin 中的「會員升級條件」設定決定回傳值：  - 若條件為「單次購物」，檢查目前會籍期間內是否有任一筆訂單達到門檻。若有訂單達門檻，則回傳金額最高者；若皆未達門檻，回傳 0。  - 若條件為「指定期限內購物」，回傳在指定期限內的累積消費金額。  若會員已達最高等級，則回傳 null。"""
+    user_spendings_for_extend: Optional[float] = None
+    """The amount used to determine if a member meets the extend criteria, based on the "Membership extension condition" in the SHOPLINE Admin:  - For "Single Purchase," returns the highest order amount that meets the threshold   during the membership period, or 0 if none meet the threshold.  - For "Purchase within specified period," returns the total spending within that period.  Returns null if the current membership has a permanent duration.    用於判斷會員是否符合續會條件的消費金額，依據 Admin 中的「會員續會條件」設定決定回傳值：  - 若條件為「單次購物」，檢查目前會籍期間內是否有任一筆訂單達到門檻。若有訂單達門檻，則回傳金額最高者；若皆未達門檻，回傳 0。  - 若條件為「指定期限內購物」，回傳在指定期限內的累積消費金額。  若當前會籍為永久期限，則回傳 null。"""
+    next_total_spending: Optional[float] = None
+    """The amount of upgrading to next membership tier.<br /> 升等到下一會員等級所需之消費金額（Admin 設定的升級金額條件）  *若沒有下一級則回傳 null"""
+    extend_total_spending: Optional[float] = None
+    """The amount of extending in current membership tier.<br /> 續會目前會員等級所需之消費金額（Admin 設定的續會金額條件）  *若沒有設定則回傳 null"""
+
+class MembershipInfo(BaseModel):
+    id: Optional[str] = None
+    """Membership tier's ID 會員等級ID"""
+    membership_tier: Optional[Membership_TierConfig] = None
+    """Membership Tier Data 顧客會員等級"""
+    tier_expires_at: Optional[str] = None
+    """The Membership Tier Expiry Time 會員到期時間"""
+    membership_tier_gap: Optional[Membership_Tier_GapConfig] = None
+    """Next membership tier's info 下一個會員等級的資料"""

shopline_sdk/models/membership_tier.py

@@ -0,0 +1,26 @@
+"""Shopline API 数据模型 - MembershipTier"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .member_point_rule import MemberPointRule
+from .membership_tier_rule import MembershipTierRule
+from .promotion import Promotion
+from .translatable import Translatable
+from .user_credit_rule import UserCreditRule
+
+
+class MembershipTier(BaseModel):
+    id: Optional[str] = None
+    """Membership tier's ID 會員等級ID"""
+    level: Optional[int] = None
+    """Level of Current Membership Tier 等級高低 - *Having higher level with larger number. 等級數越高，數字越大"""
+    name_translations: Optional[Translatable] = None
+    member_count: Optional[int] = None
+    """Number of members in this tier 此等級的會員人數"""
+    membership_tier_rules: Optional[List[MembershipTierRule]] = None
+    promotions: Optional[List[Promotion]] = None
+    member_point_rules: Optional[List[MemberPointRule]] = None
+    user_credit_rules: Optional[List[UserCreditRule]] = None

shopline_sdk/models/membership_tier_action_log.py

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

shopline_sdk/models/membership_tier_action_logs.py

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

shopline_sdk/models/membership_tier_rule.py

@@ -0,0 +1,53 @@
+"""Shopline API 数据模型 - MembershipTierRule"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Condition_IntervalConfig(BaseModel):
+    """Configuration model for condition_interval"""
+    type: Optional[Literal['within_interval', 'single_purchase']] = None
+    """Membership Upgrade Condition Type<br /> 會員升級條件類別<br /> - within_interval: 指定期限內購物<br /> - single_purchase: 單次購物"""
+    time_unit: Optional[Literal['month']] = None
+    """Membership Upgrade Condition Time Unit<br /> 會員升級條件時間單位"""
+    time_value: Optional[int] = None
+    """Valid Period of the conditional interval if the type is "within_interval"<br /> 如類別是"within_interval"，升級條件時間的值"""
+
+
+class Effect_IntervalConfig(BaseModel):
+    """Configuration model for effect_interval"""
+    type: Optional[Literal['within_interval', 'unlimited']] = None
+    """Membership Valid Period<br /> 會員有效期限"""
+    time_unit: Optional[Literal['month']] = None
+    """Unit of Valid Period<br /> 有效期限單位"""
+    time_value: Optional[int] = None
+    """Valid Period of the effect interval if the type is "within_interval"<br /> 如類別是"within_interval"，有效期間的值"""
+
+
+class Total_SpendingConfig(BaseModel):
+    """Configuration model for total_spending"""
+    cents: Optional[int] = None
+    """Total Spending Requirement represent in cents<br /> 以仙為單位表示總消費要求"""
+    currency_symbol: Optional[str] = None
+    """Total Spending Requirement represent in currency_symbol<br /> 以currency_symbol表示總消費要求"""
+    currency_iso: Optional[str] = None
+    """Total Spending Requirement represent in currency_iso<br /> 以currency_iso表示總消費要求"""
+    label: Optional[str] = None
+    """Total Spending Requirement represent in label<br /> 以標籤表示總消費要求"""
+    dollars: Optional[float] = None
+    """Total Spending Requirement represent in dollars<br /> 以元為單位表示總消費要求"""
+
+class MembershipTierRule(BaseModel):
+    id: Optional[str] = None
+    """Membership tier rule's ID<br />會員等級規則ID"""
+    effect_type: Optional[Literal['upgrade', 'extend']] = None
+    """Type of the membership_tier_rule<br /> 會員級別規則的類別"""
+    condition_interval: Optional[Condition_IntervalConfig] = None
+    effect_interval: Optional[Effect_IntervalConfig] = None
+    total_spending: Optional[Total_SpendingConfig] = None
+    created_at: Optional[str] = None
+    """The timestamp that the rule is created at<br />規則創造時間"""
+    updated_at: Optional[str] = None
+    """The timestamp that the rule is updated at<br />規則更新時間"""

shopline_sdk/models/merchant.py

@@ -0,0 +1,78 @@
+"""Shopline API 数据模型 - Merchant"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .media import Media
+from .merchant_tax import MerchantTax
+
+
+
+class Whitelisted_Ip_AddressesItem(BaseModel):
+    """Item model for whitelisted_ip_addresses"""
+    id: Optional[str] = Field(default=None, alias="_id")
+    name: Optional[str] = None
+    address: Optional[str] = None
+    updated_at: Optional[str] = None
+    created_at: Optional[str] = None
+
+class Merchant(BaseModel):
+    id: Optional[str] = None
+    """Merchant ID 商户ID"""
+    base_country_code: Optional[str] = None
+    """Country/Region code 國家/地區代碼"""
+    base_currency_code: Optional[str] = None
+    """Currency code 貨幣代碼"""
+    name: Optional[str] = None
+    """Shop Name 商店名稱"""
+    email: Optional[str] = None
+    """Shop Email 商店電郵"""
+    handle: Optional[str] = None
+    """Shop code 商店代碼"""
+    custom_domain: Optional[str] = None
+    """Shop custom domain 商店自訂網域"""
+    current_plan_key: Optional[str] = None
+    """Shop plan key 商店計劃代碼"""
+    default_language_code: Optional[str] = None
+    """Default language code 默認語言代碼"""
+    staff_id: Optional[str] = None
+    """Staff ID 管理員ID"""
+    rollout_keys: Optional[List[str]] = None
+    """Supported function keys 支援的功能代碼"""
+    supported_languages: Optional[List[str]] = None
+    """Supported languages 支援的語言"""
+    logo_media: Optional[Media] = None
+    kyc_status: Optional[Literal['not_yet_applied', 'basic_account_pending', 'basic_account_verified', 'basic_account_rejected', 'basic_account_reviewed', 'advanced_account_pending', 'advanced_account_verified', 'advanced_account_rejected', 'advanced_account_failed']] = None
+    """KYC status KYC審核狀態"""
+    admin_status: Optional[Literal['normal', 'suspended']] = None
+    """Admin status"""
+    sl_payment_merchant_id: Optional[str] = None
+    """sl_payment_merchant_id 支付中台merchant id"""
+    sl_payment_mcc: Optional[str] = None
+    """sl_payment_mcc 渠道分配的mcc"""
+    sl_payment_billing_descriptor_name: Optional[str] = None
+    """Store's billing descriptor 商店交易名稱"""
+    product_lines: Optional[Dict[str, Any]] = None
+    """Product Lines 商戶訂閱"""
+    tags: Optional[List[str]] = None
+    """tags 標籤"""
+    emails: Optional[Dict[str, Any]] = None
+    """emails 其他電郵"""
+    phones: Optional[Dict[str, Any]] = None
+    """phones 電話"""
+    pos_payment_id: Optional[str] = None
+    """POS payment id"""
+    pos_delivery_option_id: Optional[str] = None
+    """POS Delivery option id"""
+    brand_home_url: Optional[str] = None
+    """Storefront url 店鋪地址"""
+    taxes: Optional[List[MerchantTax]] = None
+    """Tax Info of Merchant 商店稅金設定"""
+    current_theme_key: Optional[str] = None
+    """The theme key that the merchant is currently 商家當前正在使用的主題  Only provided when include_fields contains 'current_theme_key'  僅於include_fields傳入 'current_theme_key' 時提供"""
+    instagram_username: Optional[str] = None
+    """The instagram username of the merchant linked currently 商家當前正在連結的Instagram用戶名稱  Only provided when include_fields contains 'instagram_username'  僅於include_fields傳入 'instagram_username' 時提供"""
+    whitelisted_ip_addresses: Optional[List[Whitelisted_Ip_AddressesItem]] = None
+    """The whitelisted IP addresses  登入 IP 位置白名單  Presented in GET /merchants/:merchant_id, but not in GET /merchants  會於 GET /merchants/:merchant_id，但不於 GET /merchants 出現"""