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

shopline_sdk/models/settlement_terminal_list.py

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

shopline_sdk/models/shop_conversation.py

@@ -0,0 +1,31 @@
+"""Shopline API 数据模型 - ShopConversation"""
+
+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 ShopConversation(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"""
+    last_message: Optional[Last_MessageConfig] = None

shopline_sdk/models/shop_conversations.py

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

shopline_sdk/models/shop_conversations_message.py

@@ -0,0 +1,30 @@
+"""Shopline API 数据模型 - ShopConversationsMessage"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class MessageConfig(BaseModel):
+    """Configuration model for message"""
+    sender_id: Optional[str] = None
+    """Sender ID 發送者 ID"""
+    sender_type: Optional[Literal['User', 'Merchant', 'Bot']] = None
+    """Sender Type 發送者類型"""
+    created_at: Optional[str] = None
+    """Created At 訊息建立時間"""
+    acting_sender_id: Optional[str] = None
+    """Performer ID 發送者 ID"""
+    is_sent_by_merchant: Optional[bool] = None
+    """Is Sent by Merchant 是否為 merchant 發送訊息"""
+    content: Optional[str] = None
+    """Content 文字內容"""
+    attachment: Optional[Dict[str, Any]] = None
+
+class ShopConversationsMessage(BaseModel):
+    id: Optional[str] = None
+    """Message ID 訊息 ID"""
+    platform: Optional[Literal['shop_messages', 'order_messages']] = None
+    """Conversation Type 訊息種類"""
+    message: Optional[MessageConfig] = None

shopline_sdk/models/shop_conversations_messages.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - ShopConversationsMessages"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .shop_conversations_message import ShopConversationsMessage
+
+
+class ShopConversationsMessages(BaseModel):
+    total: Optional[int] = None
+    """Total Number 總筆數"""
+    limit: Optional[int] = None
+    """Numbers of Shop Messages 顯示筆數"""
+    items: Optional[List[ShopConversationsMessage]] = None

shopline_sdk/models/shop_crm_setting.py

@@ -0,0 +1,24 @@
+"""Shopline API 数据模型 - ShopCrmSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Referral_ProductConfig(BaseModel):
+    """Configuration model for referral_product"""
+    enabled: Optional[bool] = None
+    referral_hours: Optional[float] = None
+
+class ShopCrmSetting(BaseModel):
+    enable_switch_channel: Optional[bool] = None
+    enable_staff_send_sms_and_signup: Optional[bool] = None
+    enable_maintain_customer_profile: Optional[bool] = None
+    enable_enter_spend_amount: Optional[bool] = None
+    enable_customer_overview: Optional[bool] = None
+    enable_agent_performance: Optional[bool] = None
+    enable_channel_performance: Optional[bool] = None
+    enable_edit_customer_tags: Optional[bool] = None
+    enable_edit_customer_memo: Optional[bool] = None
+    referral_product: Optional[Referral_ProductConfig] = None

shopline_sdk/models/shop_setting.py

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

shopline_sdk/models/staff.py

@@ -0,0 +1,61 @@
+"""Shopline API 数据模型 - Staff"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Owned_MerchantsItem(BaseModel):
+    """Item model for owned_merchants"""
+    id: Optional[str] = None
+    """Merchant ID"""
+    name: Optional[str] = None
+    """Merchant name"""
+    handle: Optional[str] = None
+    """Merchant handle"""
+    base_country_code: Optional[str] = None
+    """Merchant country code"""
+    custom_domain: Optional[str] = None
+    """Merchant custom domain"""
+
+
+class Employed_MerchantsItem(BaseModel):
+    """Item model for employed_merchants"""
+    id: Optional[str] = None
+    """Merchant ID"""
+    name: Optional[str] = None
+    """Merchant name"""
+    handle: Optional[str] = None
+    """Merchant handle"""
+    base_country_code: Optional[str] = None
+    """Merchant country code"""
+    custom_domain: Optional[str] = None
+    """Merchant custom domain"""
+
+class Staff(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    email: Optional[str] = None
+    """Email 電郵"""
+    name: Optional[str] = None
+    """Name 員工名稱"""
+    locale_code: Optional[str] = None
+    """Locale of staff using 員工語系"""
+    owned_merchants: Optional[List[Owned_MerchantsItem]] = None
+    """Associated merchants this staff owns 帳號為店長的店鋪"""
+    employed_merchants: Optional[List[Employed_MerchantsItem]] = None
+    """Associated merchants this staff belongs to 帳號服務的店鋪"""
+    user_id: Optional[str] = None
+    """user ID 使用者 ID"""
+    created_at: Optional[str] = None
+    """Created Time 創建時間"""
+    merchant_ids: Optional[List[str]] = None
+    """Associated merchant IDs this staff belongs to 帳號服務的店鋪 ID"""
+    organization_ids: Optional[List[str]] = None
+    """Associated organization IDs this staff belongs to 帳號服務的組織 ID"""
+    role_keys: Optional[List[str]] = None
+    profile_image_url: Optional[str] = None
+    """Profile image url  個人資料相片URL"""
+    channel_ids: Optional[List[str]] = None
+    """Channel IDs  頻道 IDs"""

shopline_sdk/models/staff_performance.py

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

shopline_sdk/models/start_date_param.py

@@ -0,0 +1,10 @@
+"""Shopline API 数据模型 - startDateParam"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class startDateParam(BaseModel):
+    """Starting date of the analytics 分析的開始日期"""
+    pass

shopline_sdk/models/status.py

@@ -0,0 +1,11 @@
+"""Shopline API 数据模型 - status"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class status(BaseModel):
+    """The status that will be applied on the products to the online store.  更新商品狀態至網店。"""
+    value: Literal['active', 'draft']
+    """Enum values: active, draft"""

shopline_sdk/models/stock.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - Stock"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Stock(BaseModel):
+    warehouse_id: Optional[str] = None
+    """Warehouse’s id 倉庫 id"""
+    quantity: Optional[float] = None
+    """Product’s stock in this warehouse 商品在此倉庫中的庫存"""

shopline_sdk/models/store_credit.py

@@ -0,0 +1,50 @@
+"""Shopline API 数据模型 - StoreCredit"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+class StoreCredit(BaseModel):
+    id: Optional[str] = Field(default=None, alias="_id")
+    """Record ID 紀錄 ID"""
+    customer_id: Optional[str] = None
+    """Customer ID 顧客 ID"""
+    credit_balance: Optional[int] = None
+    """Credit balance after this record 此紀錄後的購物金餘額"""
+    remarks: Optional[str] = None
+    """Credit Change Reason	 購物金更動原因"""
+    value: Optional[int] = None
+    """Credit Movement 購物金款項"""
+    end_at: Optional[str] = None
+    """Expiry Date 到期日"""
+    performer_id: Optional[str] = None
+    """ID of the staff who created this record 創建紀錄的管理員的ID"""
+    performer_name: Optional[str] = None
+    """Staff who created this record 創建紀錄的管理員"""
+    fulfillment_balance: Optional[int] = None
+    """Fulfillment Balance 購物金餘額"""
+    type: Optional[Literal['manual_credit', 'welcome_credit', 'birthday_credit', 'auto_reward', 'applied_credit', 'user_credit_expired', 'welcome_member_referral_credit', 'member_referral_credit', 'order_split_revert', 'member_info_quick_completion_credit', 'product_review_reward', 'return_order_revert', 'order_edit_revert']] = None
+    """Store credit type 購物金類型  ----  manual_credit: 手動增減購物金（店家手動發送、回補來自取消訂單/退貨訂單）  welcome_credit: 新加入會員購物金  birthday_credit: 生日購物金  auto_reward: 購物金回饋  applied_credit: 套用購物金在訂單  user_credit_expired: 購物金過期  welcome_member_referral_credit: 透過推薦連結註冊成功  member_referral_credit: 推薦新顧客進行消費  order_split_revert: 回補購物金（來自拆單）  product_review_reward: 商品評價獎賞  member_info_quick_completion_credit: 會員資料獎賞  return_order_revert: 退貨單回補購物金  order_edit_revert: 訂單編輯回補購物金"""
+    created_at: Optional[str] = None
+    """Record creation date 創建紀錄日期"""
+    customer_ref_user_id: Optional[str] = None
+    """Third party custom customer id 第三方儲存之顧客ID"""
+    status: Optional[Literal['active', 'removed', 'expired', 'used', 'redeemed']] = None
+    """Status 購物金狀態"""
+    is_redeem: Optional[bool] = None
+    """Whether the store credit is redeemed  購物金是否已經被兌換"""
+    order_id: Optional[str] = None
+    """The ID of the order where the store credit earned from 賺取購物金的訂單的ID"""
+    value_dollar: Optional[Money] = None
+    user_credit_rule_id: Optional[str] = None
+    """The ID of user_credit_rule"""
+    order_number: Optional[str] = None
+    """Order number 訂單號碼"""
+    merchant_order_number: Optional[str] = None
+    """The order number set by the merchant 店家自定義訂單號"""
+    order_created_by: Optional[str] = None
+    """Order created by 此訂單的建立者"""

shopline_sdk/models/store_credit_fulfillment.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - StoreCreditFulfillment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+
+class Never_Expire_ItemConfig(BaseModel):
+    """Configuration model for never_expire_item"""
+    total_value: Optional[float] = None
+    """The total value of never expire store credits.<br/> 永久有效的購物金加總"""
+    total_value_dollar: Optional[Money] = None
+    expire_at: Optional[str] = None
+    """This field will be null because the store credit never expire.<br/> 購物金為永久有效，此欄位為 null"""
+
+class StoreCreditFulfillment(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 store credit if items count is larger than the limit.<br/> 如果 items 的筆數大於限制，則剩餘未顯示於 items 的點數會加總顯示於此，expire_at 會顯示較快過期的日期"""
+    items: Optional[List[Any]] = None
+    """The list of store credit fulfillments which will expire in specific date.<br/> 含有到期日的購物金列表，最多顯示 limit 參數個數，剩餘會加總並顯示於 remaining_value"""
+    never_expire_item: Optional[Never_Expire_ItemConfig] = None

shopline_sdk/models/storefront_o_auth_application.py

@@ -0,0 +1,18 @@
+"""Shopline API 数据模型 - StorefrontOAuthApplication"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class StorefrontOAuthApplication(BaseModel):
+    id: Optional[str] = None
+    """Application ID"""
+    app_id: Optional[str] = None
+    """App UID (Client ID used in OAuth requests)"""
+    app_secret: Optional[str] = None
+    """App Secret (Client secret used in OAuth requests)"""
+    name: Optional[str] = None
+    """App Name"""
+    redirect_uri: Optional[str] = None
+    """Redirect URI"""

shopline_sdk/models/storefront_o_auth_applications.py

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

shopline_sdk/models/storefront_token.py

@@ -0,0 +1,26 @@
+"""Shopline API 数据模型 - StorefrontToken"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .storefront_token_merchant import StorefrontTokenMerchant
+
+
+class StorefrontToken(BaseModel):
+    """The merchant that this storefront token can access"""
+    id: Optional[str] = None
+    """Token ID 令牌ID"""
+    token: Optional[str] = None
+    """A JWT storefront token string JWT店面令牌字串"""
+    staff_id: Optional[str] = None
+    """ID of the staff that created this token 創建這令牌的staff ID"""
+    application_id: Optional[str] = None
+    """ID of the application that created this token 創建這令牌的程式"""
+    merchant: Optional[StorefrontTokenMerchant] = None
+    staff: Optional[StorefrontTokenMerchant] = None
+    backend_token: Optional[bool] = None
+    """Indicate if it is a backend token for different setup such as ratelimit"""
+    created_at: Optional[str] = None
+    """The date and time when the token was created 令牌創建的日期和時間"""

shopline_sdk/models/storefront_token_merchant.py

@@ -0,0 +1,17 @@
+"""Shopline API 数据模型 - StorefrontTokenMerchant"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class StorefrontTokenMerchant(BaseModel):
+    """The merchant that this storefront token can access 這令牌能存取的商户"""
+    id: Optional[str] = None
+    """Merchant ID 商户ID"""
+    name: Optional[str] = None
+    """Merchant name 商户名稱"""
+    email: Optional[str] = None
+    """Merchant email 商户電郵"""
+    handle: Optional[str] = None
+    """Merchant handle 商户handle"""

shopline_sdk/models/storefront_token_staff.py

@@ -0,0 +1,15 @@
+"""Shopline API 数据模型 - StorefrontTokenStaff"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class StorefrontTokenStaff(BaseModel):
+    """The staff that created this storefront token 創建這令牌的商户"""
+    id: Optional[str] = None
+    """Staff ID 員工ID"""
+    name: Optional[str] = None
+    """Staff name 員工名稱"""
+    email: Optional[str] = None
+    """Staff email 員工電郵"""

shopline_sdk/models/storefront_tokens.py

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

shopline_sdk/models/supplier.py

@@ -0,0 +1,24 @@
+"""Shopline API 数据模型 - Supplier"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class Supplier(BaseModel):
+    id: Optional[str] = None
+    """Id of the supplier 供應商ID"""
+    name_translations: Optional[Translatable] = None
+    name: Optional[str] = None
+    """Name of the supplier 供應商名稱"""
+    address: Optional[str] = None
+    """Address of the supplier 供應商地址"""
+    phone: Optional[str] = None
+    """Phone of the supplier 供應商電話號碼"""
+    note: Optional[str] = None
+    """Note of the supplier 供應商備注"""
+    status: Optional[str] = None
+    """Working status of the supplier 供應商狀態 (active/removed)"""

shopline_sdk/models/tag.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - Tag"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Tag(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    content: Optional[str] = None
+    """Text content of the tag 標籤內容"""
+    owner_id: Optional[str] = None
+    """Associated ID of the tag 標籤對應資源的ID"""
+    owner_type: Optional[str] = None
+    """Associated type of the tag 標籤對應資源的類別"""

shopline_sdk/models/taggable.py

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

shopline_sdk/models/tax.py

@@ -0,0 +1,57 @@
+"""Shopline API 数据模型 - Tax"""
+
+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[Union[TaxRegion]]] = None
+
+
+class DeliveryConfig(BaseModel):
+    """Configuration model for delivery"""
+    general: Optional[TaxRegion] = None
+    details: Optional[List[Union[TaxRegion]]] = None
+
+
+class Service_ChargeConfig(BaseModel):
+    """Configuration model for service_charge"""
+    general: Optional[TaxRegion] = None
+    details: Optional[List[Union[TaxRegion]]] = None
+
+class Tax(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    name: Optional[str] = None
+    """name"""
+    merchant_id: Optional[str] = None
+    """merchant ID"""
+    country: Optional[str] = None
+    """Country of the tax 稅收國家/地區"""
+    is_default_rates: Optional[bool] = None
+    """Using default tax rates 自動計算稅率"""
+    enable_inclusive: Optional[bool] = None
+    """All products' price include tax 所有商品皆已含稅"""
+    allow_inclusive_tax: Optional[bool] = None
+    """Allow inclusive_tax 國家商品允許含稅"""
+    service_charge_taxable: Optional[bool] = None
+    """Service charge taxable 服務稅應稅"""
+    emoji_flag: Optional[str] = None
+    """emoji flag 國家emoji"""
+    sales: Optional[SalesConfig] = None
+    """tax of sales 基本消費稅"""
+    delivery: Optional[DeliveryConfig] = None
+    """tax of delivery 運費稅"""
+    service_charge: Optional[Service_ChargeConfig] = None
+    """Tax of service charge 服務稅"""
+    created_at: Optional[str] = None
+    """Created Date 稅收創造時間 (UTC +0)"""
+    updated_at: Optional[str] = None
+    """Created Date 稅收更新時間 (UTC +0)"""

shopline_sdk/models/tax_info.py

@@ -0,0 +1,22 @@
+"""Shopline API 数据模型 - TaxInfo"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class TaxInfo(BaseModel):
+    min: Optional[float] = None
+    """Max rate 套用最低稅率"""
+    max: Optional[float] = None
+    """Min rate 套用最高稅率"""
+    country_code: Optional[str] = None
+    """ISO Country Code 稅收國家或地區（ISO 標準國家代碼）"""
+    flag: Optional[str] = None
+    """Flag 國家旗幟"""
+    region: Optional[str] = None
+    """Tax Region 稅收地區"""
+    city: Optional[str] = None
+    """City 城市"""
+    name: Optional[str] = None
+    """Tax Name 稅金名稱"""

shopline_sdk/models/tax_region.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - TaxRegion"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class TaxRegion(BaseModel):
+    id: Optional[str] = None
+    """Tax region ID 稅務地區ID"""
+    region: Optional[str] = None
+    """Tax region 稅務地區"""
+    rate: Optional[float] = None
+    """Tax rate 稅率"""
+    type: Optional[str] = None
+    """Tax type 稅別"""
+    default_rate: Optional[float] = None
+    """Default tax rate 預設稅率"""
+    default_rate_range: Optional[List[float]] = None
+    """Default tax rate range 預設稅率範圍"""

shopline_sdk/models/tax_setting.py

@@ -0,0 +1,10 @@
+"""Shopline API 数据模型 - TaxSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class TaxSetting(BaseModel):
+    products_taxable: Optional[bool] = None
+    """All Shops need Tax Collection 全店皆需收稅"""