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

shopline_sdk/models/update_event_tracker_body.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - UpdateEventTrackerBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Config_DataConfig(BaseModel):
+    """Configuration model for config_data"""
+    tracking_code: str
+    """Tracking code 追蹤碼"""
+    access_token: str
+    """Access token"""
+    dynamic_remarketing: Optional[bool] = None
+    """Dynamic Remarketing, specific for some kinds of event trackers."""
+    single_variation: Optional[bool] = None
+    """Single Variation, specific for some kinds of event trackers."""
+    unique_ids: Optional[bool] = None
+    """Unique IDs, specific for some kinds of event trackers."""
+
+class UpdateEventTrackerBody(BaseModel):
+    """Payload for updating an event tracker"""
+    event_key: Literal['tiktok', 'facebook_standard_pixel']
+    """The platform of tracking services. The event key must match with the existing record  追蹤平台。event_key 必須與現在的一致"""
+    config_data: Config_DataConfig
+    """Config data, each event_key has its own config  設定，每個event_key都有各自的config"""

shopline_sdk/models/update_flash_price_campaign_body.py

@@ -0,0 +1,22 @@
+"""Shopline API 数据模型 - UpdateFlashPriceCampaignBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class ProductConfig(BaseModel):
+    """Configuration model for product"""
+    start_at: str
+    """The start time of the event 商品限時促銷價活動的開始時間  *Should use UTC time  *應使用UTC時間"""
+    end_at: str
+    """The end time of the event 商品限時促銷價活動的結束時間  *Should use UTC time  *應使用UTC時間"""
+    title: str
+    """Flash price campaign's title 商品限時促銷價活動的名稱"""
+    price_sets: Optional[List[Dict[str, Any]]] = None
+    """The product price sets of this flash price campaigns.  商品限時促銷價活動的商品限時價格。"""
+
+class UpdateFlashPriceCampaignBody(BaseModel):
+    """Payload for updating flash price campaign"""
+    product: Optional[ProductConfig] = None

shopline_sdk/models/update_gift_body.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - UpdateGiftBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .gift import Gift
+from .translatable import Translatable
+
+
+class UpdateGiftBody(BaseModel):
+    """Payload for updating gift"""
+    title_translations: Optional[Translatable] = None
+    unlimited_quantity: Optional[bool] = None
+    sku: Optional[str] = None
+    cost: Optional[Translatable] = None
+    weight: Optional[float] = None
+    quantity: Optional[float] = None
+    media_ids: Optional[List[str]] = None

shopline_sdk/models/update_lock_inventory_body.py

@@ -0,0 +1,21 @@
+"""Shopline API 数据模型 - UpdateLockInventoryBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Meta_DataConfig(BaseModel):
+    """Configuration model for meta_data"""
+    start_time: Optional[str] = None
+
+class UpdateLockInventoryBody(BaseModel):
+    """Payload for updating product lock inventory"""
+    virtual_cart_id: str
+    variation_key: Optional[str] = None
+    original_quantity: float
+    changed_quantity: float
+    expired_time: str
+    meta_data: Optional[Meta_DataConfig] = None
+    lock_inventory_id: Optional[str] = None

shopline_sdk/models/update_metafield_body.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - UpdateMetafieldBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .metafield_value import MetafieldValue
+
+
+class UpdateMetafieldBody(BaseModel):
+    """Payload for updating metafield"""
+    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/update_product_body.py

@@ -0,0 +1,66 @@
+"""Shopline API 数据模型 - UpdateProductBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .product import Product
+from .product_variation import ProductVariation
+from .translatable import Translatable
+
+
+
+class Variant_Custom_Type_TranslationsItem(BaseModel):
+    """Item model for variant_custom_type_translations"""
+    name_translations: Optional[Translatable] = None
+    type: Optional[str] = None
+
+class UpdateProductBody(BaseModel):
+    """Payload for updating product"""
+    title_translations: Optional[Translatable] = None
+    summary_translations: Optional[Translatable] = None
+    description_translations: Optional[Translatable] = None
+    show_custom_related_products: Optional[bool] = None
+    related_product_ids: Optional[List[str]] = None
+    same_price: Optional[bool] = None
+    location_id: Optional[str] = None
+    sku: Optional[str] = None
+    seo_title_translations: Optional[Translatable] = None
+    seo_description_translations: Optional[Translatable] = None
+    seo_keywords: Optional[str] = None
+    link: Optional[str] = None
+    is_reminder_active: Optional[bool] = None
+    is_preorder: Optional[bool] = None
+    preorder_limit: Optional[int] = None
+    preorder_note_translations: Optional[Translatable] = None
+    max_order_quantity: Optional[int] = None
+    weight: Optional[float] = None
+    tags: Optional[str] = None
+    """Tags 標籤  *Tags are used to search products at the admin panel and help  set up the product-related coupons.  標籤功能用作商品搜尋，並能為指定商品設置優惠券的用途。"""
+    blacklisted_delivery_option_ids: Optional[List[str]] = None
+    blacklisted_payment_ids: Optional[List[str]] = None
+    available_start_time: Optional[str] = None
+    available_end_time: Optional[str] = None
+    schedule_publish_at: Optional[str] = None
+    category_ids: Optional[List[str]] = None
+    tax_type: Optional[str] = None
+    """Tax type 國內稅項"""
+    oversea_tax_type: Optional[str] = None
+    """Oversea tax type 海外稅項"""
+    status: Optional[Literal['active', 'draft', 'removed', 'hidden']] = None
+    images: Optional[List[str]] = None
+    detail_images: Optional[List[str]] = None
+    """Additional Product Photos 更多商品圖片"""
+    gtin: Optional[str] = None
+    barcode_type: Optional[Literal['Code 128', 'Bookland EAN', 'ISBN']] = None
+    variant_custom_type_translations: Optional[List[Variant_Custom_Type_TranslationsItem]] = None
+    variant_options: Optional[List[Dict[str, Any]]] = None
+    is_replace_variations: Optional[bool] = None
+    """Is replacing variations? 是否更換全部規格?"""
+    variations: Optional[List[ProductVariation]] = None
+    unlimited_quantity: Optional[bool] = None
+    default_show_image_selector: Optional[bool] = None
+    """Show variation photos. 展示商品規格圖像。"""
+    allow_gift: Optional[bool] = None
+    """Specifies whether the item can be set as a gift.  是否可以設為贈品  true: the product can be set as a gift.  false: the product cannot be set as a gift."""

shopline_sdk/models/update_product_feed_setting_body.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - UpdateProductFeedSettingBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class UpdateProductFeedSettingBody(BaseModel):
+    """Payload for updating an product feed setting"""
+    unique_ids: Optional[bool] = None
+    """是否要用系統 id 取代 sku"""
+    title: Optional[str] = None
+    """The title of the product feed setting"""
+    total_product_count: Optional[float] = None
+    """The total product count of the product feed setting"""
+    with_out_of_stock_product: Optional[bool] = None
+    """Whether to include out of stock products"""
+    with_preorder_product: Optional[bool] = None
+    """Whether to include preorder products"""
+    category_ids: Optional[List[str]] = None
+    """The category ids of the product feed setting"""
+    main_product_image_select: Optional[float] = None
+    """The main product image select of the product feed setting"""
+    variant_product_image_select: Optional[float] = None
+    """The variant product image select of the product feed setting"""
+    locale: Optional[str] = None
+    """The locale of the product feed setting"""

shopline_sdk/models/update_product_review_comment_body.py

@@ -0,0 +1,18 @@
+"""Shopline API 数据模型 - UpdateProductReviewCommentBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .product_review_comment import ProductReviewComment
+
+
+class UpdateProductReviewCommentBody(BaseModel):
+    """Payload for updating product review comment"""
+    user_name: Optional[str] = None
+    status: Optional[str] = None
+    score: Optional[int] = None
+    comment: Optional[str] = None
+    media_ids: Optional[List[str]] = None
+    """Array of media ids 媒體id陣列"""

shopline_sdk/models/update_product_variation_body.py

@@ -0,0 +1,34 @@
+"""Shopline API 数据模型 - UpdateProductVariationBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .product import Product
+
+
+class UpdateProductVariationBody(BaseModel):
+    """Payload for updating product variation"""
+    location_id: Optional[str] = None
+    sku: Optional[str] = None
+    price: Optional[float] = None
+    """Price (Note: Cannot be set to null. Product with a price of 0 cannot be sold.)  原價格 (備註：不能設定為null。價格為0的商品不能被售出)"""
+    retail_price: Optional[float] = None
+    """Retail Price 零售價"""
+    product_price_tiers: Optional[Dict[str, str]] = None
+    """Membership tier's ID 會員等級ID"""
+    member_price: Optional[float] = None
+    """Member Price 會員價"""
+    quantity: Optional[int] = None
+    """Product Variation Quantity 規格商品數量 -  Directly update the quantity of the variation. The quantity is between -9999999 to 9999999.  直接更新規格商品數量。商品數量要在 -9999999 - 9999999 之間。"""
+    preorder_limit: Optional[int] = None
+    image: Optional[str] = None
+    """Link of Images 圖片連結"""
+    price_sale: Optional[float] = None
+    """Price on sale  (Note: Cannot be set to null.   Product with a price_sale of 0 will be sold at its original price.)  特價 (備註：不能設定為null。特價為0的商品會以原價售出)"""
+    cost: Optional[float] = None
+    """Cost (Note: Cannot be set to null)  成本 (備註：不能設定為null)"""
+    weight: Optional[float] = None
+    """Weight (kg) 重量 (公斤)"""
+    gtin: Optional[str] = None

shopline_sdk/models/update_promotion_body.py

@@ -0,0 +1,71 @@
+"""Shopline API 数据模型 - UpdatePromotionBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .addon_product import AddonProduct
+from .gift import Gift
+from .promotion import Promotion
+from .promotion_condition import PromotionCondition
+from .translatable import Translatable
+
+
+
+class ConditionsItem(BaseModel):
+    """Item model for conditions"""
+    id: Optional[str] = None
+    min_item_count: Optional[int] = None
+    min_price: Optional[float] = None
+    whitelisted_product_ids: Optional[List[str]] = None
+    whitelisted_category_ids: Optional[List[str]] = None
+    blacklisted_product_ids: Optional[List[str]] = None
+
+
+class Benefit_TiersItem(BaseModel):
+    """Item model for benefit_tiers"""
+    id: Optional[str] = None
+    min_item_count: Optional[int] = None
+    min_price: Optional[float] = None
+    discountable_product_ids: Optional[str] = None
+
+
+class Addon_ProductsItem(BaseModel):
+    """Item model for addon_products"""
+    addon_product_id: Optional[str] = None
+    discounted_price: Optional[float] = None
+    discountable_quantity: Optional[float] = None
+
+
+class GiftsItem(BaseModel):
+    """Item model for gifts"""
+    gift_id: Optional[str] = None
+    discounted_point: Optional[float] = None
+
+class UpdatePromotionBody(BaseModel):
+    """Payload for updating promotion"""
+    title_translations: Optional[Translatable] = None
+    discountable_product_ids: Optional[List[str]] = None
+    discountable_category_ids: Optional[List[str]] = None
+    is_accumulated: Optional[bool] = None
+    requires_membership: Optional[bool] = None
+    whitelisted_membership_tier_ids: Optional[List[str]] = None
+    whitelisted_tag_contents: Optional[List[str]] = None
+    user_max_use_count: Optional[int] = None
+    conditions: Optional[List[ConditionsItem]] = None
+    benefit_tiers: Optional[List[Benefit_TiersItem]] = None
+    show_coupon: Optional[bool] = None
+    max_use_count: Optional[int] = None
+    start_at: Optional[str] = None
+    end_at: Optional[str] = None
+    whitelisted_delivery_option_ids: Optional[List[str]] = None
+    whitelisted_payment_ids: Optional[List[str]] = None
+    banner_media_ids: Optional[List[str]] = None
+    seo_enabled: Optional[bool] = None
+    seo_title_translations: Optional[Translatable] = None
+    seo_description_translations: Optional[Translatable] = None
+    seo_keywords: Optional[str] = None
+    term_translations: Optional[Translatable] = None
+    addon_products: Optional[List[Addon_ProductsItem]] = None
+    gifts: Optional[List[GiftsItem]] = None

shopline_sdk/models/update_return_order_body.py

@@ -0,0 +1,17 @@
+"""Shopline API 数据模型 - UpdateReturnOrderBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .return_order import ReturnOrder
+
+
+class UpdateReturnOrderBody(BaseModel):
+    """Payload for update return order"""
+    status: Optional[Literal['confirmed', 'completed', 'cancelled']] = None
+    user_credit_expired_at: Optional[str] = None
+    """Credit expiry date, a null value means never expired   (After return_order_revamp feature key on)  購物金到期日期, null 表示不會到期 (啟用「return_order_revamp」功能後)"""
+    member_point_expired_at: Optional[str] = None
+    """Member point expiry date, a null value means never expired<br/> (After return_order_revamp feature key on)<br/> 會員點數到期日期, null 表示不會到期 (啟用「return_order_revamp」功能後)"""

shopline_sdk/models/update_webhook_body.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - UpdateWebhookBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .webhook import Webhook
+
+
+class UpdateWebhookBody(BaseModel):
+    """Payload for updating webhook"""
+    address: Optional[str] = None
+    topics: Optional[List[Literal['user/create', 'user/update', 'user/remove', 'user/sign_in', 'user/mobile_sign_in', 'user/mobile_sign_up', 'user/membership_tier_update', 'order/cancel', 'order/create', 'order/update', 'order/remove', 'order/pending', 'order/confirm', 'order/complete', 'order/status_notify_customer', 'order/product_detail_notify_customer', 'order/combine_orders', 'order/split_order', 'order_payment/update', 'order_payment/complete', 'order_payment/refund', 'order_payment/status_notify_customer', 'order_delivery/update', 'order_delivery/status_notify_customer', 'return_order/create', 'return_order/complete', 'return_order/cancel', 'pos_return_order/create', 'pos_return_order/update', 'page/create', 'page/update', 'product/create', 'product/update', 'product/remove', 'product/back_in_stock', 'product_review_comment/create', 'user_credit/create', 'user_credit/update', 'invoice/create', 'invoice/update', 'tax/create', 'tax/update', 'tax/remove', 'payment/create', 'payment/update', 'payment/remove', 'member_point/create', 'merchant/update', 'tag/create', 'tag/remove', 'persistent_cart/abandoned_cart', 'comment/payment_slip_upload', 'promotion/redeem', 'customer_group/update', 'customer_group/remove', 'warehouse/create', 'stock/update']]] = None

shopline_sdk/models/user_coupon.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - UserCoupon"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class UserCoupon(BaseModel):
+    id: Optional[str] = None
+    """User Coupon ID"""
+    user_id: Optional[str] = None
+    """User ID 使用者 ID"""

shopline_sdk/models/user_coupons.py

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

shopline_sdk/models/user_credit_rule.py

@@ -0,0 +1,40 @@
+"""Shopline API 数据模型 - UserCreditRule"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Apply_ConditionsItem(BaseModel):
+    """Item model for apply_conditions"""
+    credit_value: Optional[int] = None
+    """Credit Value 購物金"""
+    apply_threshold: Optional[int] = None
+    """Apply Threshold 購物金折抵門檻"""
+
+class UserCreditRule(BaseModel):
+    id: Optional[str] = None
+    status: Optional[Literal['active', 'inactive']] = None
+    rule_type: Optional[Literal['pos_apply_credit', 'auto_reward', 'apply_partial_credit', 'welcome_credit', 'birthday_credit', 'max_amount_per_order', 'max_percentage_per_order', 'apply_user_credit']] = None
+    """pos_apply_credit: POS 購物金折抵 auto_reward: 滿額送購物金 apply_partial_credit: 允許顧客自行設定折抵金額 welcome_credit: 新加入會員購物金 birthday_credit: 生日購物金 max_amount_per_order: (舊) 購物金折抵上限 by amount max_percentage_per_order: (舊) 購物金折抵上限 by percentage apply_user_credit: (新) 折抵購物金上限，支援多層級設定"""
+    credit_value: Optional[int] = None
+    """購物金"""
+    credit_value_type: Optional[Literal['amount', 'percentage']] = None
+    """Only the rule whose rule_type is apply_user_credit will use this field to distinguish the credit_value is fixed amount or percentage.  僅 rule_type 為 apply_user_credit 的規則會使用到，用來區分 credit_value 的值是固定金額還是百分比"""
+    credit_valid_period: Optional[int] = None
+    """購物金有效日期（天），0 / -1 代表無限"""
+    credit_threshold: Optional[int] = None
+    """購物金生效條件"""
+    is_accumulated: Optional[bool] = None
+    """自動累計"""
+    accumulated_type: Optional[Literal['credit', 'percentage']] = None
+    """累計類型 credit: 固定金額 percentage: 百分比"""
+    apply_threshold: Optional[int] = None
+    """購物金生效條件"""
+    apply_conditions: Optional[List[Apply_ConditionsItem]] = None
+    """Tiered application of user credits. 套用購物金折抵條件(多階層)"""
+    created_at: Optional[str] = None
+    """Created Date 創造時間 (UTC +0)"""
+    updated_at: Optional[str] = None
+    """Created Date 更新時間 (UTC +0)"""

shopline_sdk/models/users_setting.py

@@ -0,0 +1,83 @@
+"""Shopline API 数据模型 - UsersSetting"""
+
+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 .user_credit_rule import UserCreditRule
+
+
+
+class Line_LoginConfig(BaseModel):
+    """Configuration model for line_login"""
+    status: Optional[Literal['active', 'inactive']] = None
+    """line login active status"""
+
+
+class Facebook_LoginConfig(BaseModel):
+    """Configuration model for facebook_login"""
+    status: Optional[Literal['active', 'inactive']] = None
+    """facebook login enable status"""
+    app_id: Optional[str] = None
+    """facebook app id"""
+    app_secret: Optional[str] = None
+    """facebook app_secret"""
+    client_token: Optional[str] = None
+    """facebook client_token"""
+
+
+class Enable_Facebook_CommentConfig(BaseModel):
+    """Configuration model for enable_facebook_comment"""
+    status: Optional[bool] = None
+    """facebook comment enable status"""
+
+
+class Email_VerificationConfig(BaseModel):
+    """Configuration model for email_verification"""
+    status: Optional[str] = None
+    """email verification enable status"""
+
+
+class Email_Login_With_VerificationConfig(BaseModel):
+    """Configuration model for email_login_with_verification"""
+    status: Optional[str] = None
+    """email login verification enable status"""
+
+
+class Sms_VerificationConfig(BaseModel):
+    """Configuration model for sms_verification"""
+    status: Optional[str] = None
+    """mobile_phone verification enable status"""
+    supported_countries: Optional[List[str]] = None
+    """mobile_phone support countries"""
+
+class UsersSetting(BaseModel):
+    birthday_format: Optional[Literal['YYYY/MM/DD', 'YYYY/MM', 'MM/DD']] = None
+    """The birthday format of the user (default: "YYYY/MM/DD")  會員生日格式（預設："YYYY/MM/DD"）"""
+    send_birthday_credit_period: Optional[Literal['monthly', 'daily']] = None
+    """The birthday credit sending setting of the user (default: "daily")  會員生日點數發送時間（預設："daily"為當日, "monthly"為當月一號）"""
+    line_login: Optional[Line_LoginConfig] = None
+    facebook_login: Optional[Facebook_LoginConfig] = None
+    enable_facebook_comment: Optional[Enable_Facebook_CommentConfig] = None
+    pos_apply_credit: Optional[bool] = None
+    pos_apply_member_point: Optional[bool] = None
+    user_credit_rules: Optional[List[UserCreditRule]] = None
+    member_point_rules: Optional[List[MemberPointRule]] = None
+    minimum_age_limit: Optional[str] = None
+    """The minimum age required for customers to shop at the online store 在網店購物的年齡下限  minimum: "13"  最小: "13"  maximum: "130"  最大: "130" """
+    enable_member_point: Optional[bool] = None
+    """Whether the member point rules are activated  會員點數規則是否正在生效"""
+    enable_user_credit: Optional[bool] = None
+    """Store Credits Toggle 商店購物金總開關"""
+    enable_age_policy: Optional[bool] = None
+    """Age Policy Toggle 是否開啟顧客已滿年齡同意文案"""
+    email_verification: Optional[Email_VerificationConfig] = None
+    """Require customer email verification 是否開啟顧客電郵驗證"""
+    email_login_with_verification: Optional[Email_Login_With_VerificationConfig] = None
+    """Customer login requrie email verification 是否開啟顧客完成電郵驗證後才可能入"""
+    sms_verification: Optional[Sms_VerificationConfig] = None
+    """Require customer sms verification 是否開啟顧客手機驗證"""
+    signup_method: Optional[Literal['email', 'mobile', 'email_and_mobile']] = None
+    """Customer signup method 顧客註冊方式"""

shopline_sdk/models/utm_data.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - UtmData"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class UtmData(BaseModel):
+    utm_source: Optional[str] = None
+    """UTM Source 標識哪個站點發送了流量，並且是必填參數。"""
+    utm_campaign: Optional[str] = None
+    """UTM Campaign 標識特定的產品促銷或戰略活動。"""
+    utm_medium: Optional[str] = None
+    """UTM Medium 標識所使用的鏈接類型，例如每次點擊或電子郵件的費用。"""
+    utm_content: Optional[str] = None
+    """UTM Content 標識用於將用戶帶到網站的具體操作，例如橫幅廣告或文本鏈接。 它通常用於A / B測試和以內容定位的廣告。 textlink logolink"""
+    utm_term: Optional[str] = None
+    """UTM Term 標識搜索詞。"""
+    utm_time: Optional[str] = None
+    """UTM Time"""

shopline_sdk/models/warehouse.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - Warehouse"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Warehouse(BaseModel):
+    id: Optional[str] = None
+    """Warehouse’s id 倉庫 id"""
+    name: Optional[str] = None
+    """Warehouse’s name 倉庫名稱"""
+    status: Optional[Literal['active', 'transferring']] = None
+    """Warehouse’s status 倉庫狀態"""

shopline_sdk/models/warehouses_cursor_based.py

@@ -0,0 +1,17 @@
+"""Shopline API 数据模型 - WarehousesCursorBased"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .cursor_based_paginatable import CursorBasedPaginatable
+from .product import Product
+
+
+class WarehousesCursorBased(BaseModel):
+    last_id: Optional[str] = None
+    limit: Optional[int] = None
+    items: Optional[List[Product]] = None
+    removed_item_ids: Optional[List[Any]] = None
+    price_sets: Optional[Dict[str, Any]] = None

shopline_sdk/models/webhook.py

@@ -0,0 +1,23 @@
+"""Shopline API 数据模型 - Webhook"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Webhook(BaseModel):
+    id: Optional[str] = None
+    """Webhook ID"""
+    format: Optional[Literal['json']] = None
+    """Webhook format Webhook格式 --- Currently support "json" only 現只支援"json" """
+    address: Optional[str] = None
+    """URL to receive the webhook 接收Webhook的URL"""
+    status: Optional[Literal['active', 'removed']] = None
+    """Webhook status Webhook狀態"""
+    merchant_id: Optional[str] = None
+    """Merchant ID 商户ID"""
+    created_at: Optional[str] = None
+    """Webhook created time Webhook創建日期"""
+    updated_at: Optional[str] = None
+    """Webhook updated time Webhook更新時間"""
+    topics: Optional[List[Literal['user/create', 'user/update', 'user/remove', 'user/sign_in', 'user/mobile_sign_in', 'user/mobile_sign_up', 'user/membership_tier_update', 'order/cancel', 'order/create', 'order/update', 'order/remove', 'order/pending', 'order/confirm', 'order/complete', 'order/status_notify_customer', 'order/product_detail_notify_customer', 'order/combine_orders', 'order/split_order', 'order_payment/update', 'order_payment/complete', 'order_payment/refund', 'order_payment/status_notify_customer', 'order_delivery/update', 'order_delivery/status_notify_customer', 'return_order/create', 'return_order/complete', 'return_order/cancel', 'pos_return_order/create', 'pos_return_order/update', 'page/create', 'page/update', 'product/create', 'product/update', 'product/remove', 'product/back_in_stock', 'product_review_comment/create', 'user_credit/create', 'user_credit/update', 'invoice/create', 'invoice/update', 'tax/create', 'tax/update', 'tax/remove', 'payment/create', 'payment/update', 'payment/remove', 'member_point/create', 'merchant/update', 'tag/create', 'tag/remove', 'persistent_cart/abandoned_cart', 'comment/payment_slip_upload', 'promotion/redeem', 'customer_group/update', 'customer_group/remove', 'warehouse/create', 'stock/update']]] = None

shopline_sdk/models/webhooks.py

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