@optima-chat/commerce-cli 1.0.0

package/dist/api/rest/commerce.d.ts

@@ -0,0 +1,730 @@
+interface Product {
+    id?: string;
+    product_id?: string;
+    title: string;
+    name?: string;
+    handle?: string;
+    description?: string;
+    price: number;
+    currency?: string;
+    stock?: number;
+    quantity?: number;
+    sku?: string;
+    status?: 'active' | 'inactive' | 'draft' | 'archived';
+    category_id?: string;
+    images?: string[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface Order {
+    id?: string;
+    order_id?: string;
+    customer_name?: string;
+    customer_email?: string;
+    total?: number;
+    amount?: number;
+    currency?: string;
+    status?: 'pending' | 'paid' | 'processing' | 'shipped' | 'delivered' | 'completed' | 'cancelled' | 'refunded';
+    shipping_address?: string;
+    tracking_number?: string;
+    carrier?: string;
+    stripe_payment_intent_id?: string;
+    items?: OrderItem[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface OrderItem {
+    product_id: string;
+    product_name?: string;
+    name?: string;
+    quantity: number;
+    price: number;
+}
+interface InventoryItem {
+    product_id: string;
+    product_name?: string;
+    name?: string;
+    stock: number;
+    quantity?: number;
+    updated_at?: string;
+}
+interface Merchant {
+    id?: string;
+    merchant_id?: string;
+    name: string;
+    slug?: string;
+    email?: string;
+    description?: string;
+    logo_url?: string;
+    banner_url?: string;
+    default_currency?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+interface ShippingZone {
+    id?: string;
+    zone_id?: string;
+    name: string;
+    countries: string[];
+    rates?: ShippingRate[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface ShippingZoneListItem {
+    id: string;
+    name: string;
+    priority: number;
+    is_default: boolean;
+    is_active: boolean;
+    country_count: number;
+    rate_count: number;
+    created_at: string;
+}
+interface ShippingRate {
+    id?: string;
+    rate_id?: string;
+    zone_id: string;
+    min_weight: number;
+    max_weight?: number;
+    price: number;
+    currency?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+interface Variant {
+    id?: string;
+    variant_id?: string;
+    product_id: string;
+    sku?: string;
+    price?: number;
+    stock?: number;
+    attributes?: Record<string, string>;
+    images?: string[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface HomepageSection {
+    id?: string;
+    type: 'banner' | 'collections' | 'collection_products' | 'featured';
+    title: string;
+    position?: number;
+    handle?: string;
+    settings?: Record<string, any>;
+    translations?: HomepageSectionTranslation[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface HomepageSectionTranslation {
+    language_code: string;
+    title?: string;
+    description?: string;
+}
+interface MoveInput {
+    section_id: string;
+    new_position: number;
+}
+interface SectionCreateRequest {
+    type: 'banner' | 'collections' | 'collection_products' | 'featured';
+    title: string;
+    settings?: Record<string, any>;
+}
+interface SectionUpdateRequest {
+    title?: string;
+    settings?: Record<string, any>;
+}
+interface SectionListResponse {
+    sections: HomepageSection[];
+}
+interface SectionReorderResponse {
+    sections: HomepageSection[];
+}
+interface BannerImagesUpdateRequest {
+    images: string[];
+}
+interface CollectionsUpdateRequest {
+    collection_slugs: string[];
+}
+interface FeaturedTargetUpdateRequest {
+    target_type: 'collection' | 'product';
+    target_handle: string;
+}
+interface TranslationUpdateRequest {
+    title?: string;
+    description?: string;
+}
+interface TranslationListResponse {
+    translations: HomepageSectionTranslation[];
+}
+interface Collection {
+    id?: string;
+    slug: string;
+    name: string;
+    description?: string;
+    handle?: string;
+    image_url?: string;
+    product_count?: number;
+    created_at?: string;
+    updated_at?: string;
+}
+interface CollectionCreateRequest {
+    slug: string;
+    name: string;
+    description?: string;
+    image_url?: string;
+}
+interface CollectionUpdateRequest {
+    slug?: string;
+    name?: string;
+    description?: string;
+    image_url?: string;
+}
+interface CollectionListResponse {
+    collections: Collection[];
+    total?: number;
+    limit?: number;
+    offset?: number;
+}
+interface CollectionResponse {
+    collection: Collection;
+}
+interface CollectionProductsRequest {
+    product_ids: string[];
+}
+interface CollectionProductsResponse {
+    products: Product[];
+    total?: number;
+}
+interface Tag {
+    name: string;
+    product_count?: number;
+    created_at?: string;
+}
+interface TagListResponse {
+    tags: Tag[];
+    total?: number;
+}
+interface TagResponse {
+    tag: Tag;
+}
+interface TagStatsResponse {
+    name: string;
+    product_count: number;
+    created_at?: string;
+}
+declare class CommerceApiClient {
+    private client;
+    constructor();
+    /**
+     * 重新初始化客户端（当 API URL 改变时调用）
+     */
+    reinitialize(): void;
+    products: {
+        /**
+         * 创建商品
+         */
+        create: (data: Partial<Product>) => Promise<Product>;
+        /**
+         * 商品列表
+         */
+        list: (params?: {
+            limit?: number;
+            offset?: number;
+            status?: string;
+            category_id?: string;
+            search?: string;
+        }) => Promise<{
+            products: Product[];
+            total: number;
+        }>;
+        /**
+         * 商品详情
+         */
+        get: (productId: string) => Promise<Product>;
+        /**
+         * 更新商品
+         */
+        update: (productId: string, data: Partial<Product>) => Promise<Product>;
+        /**
+         * 删除商品（软删除）
+         */
+        delete: (productId: string) => Promise<void>;
+        /**
+         * 添加商品图片（两步流程）
+         * 1. 先上传图片到存储获取 media_id
+         * 2. 再关联 media_id 到商品
+         */
+        addImages: (productId: string, imagePaths: string[]) => Promise<Product>;
+        /**
+         * 添加商品图片（通过 URL）
+         * 直接用图片 URL 关联到商品（后端会下载）
+         */
+        addImageUrls: (productId: string, imageUrls: string[]) => Promise<Product>;
+        /**
+         * 添加商品图片（通过 Media ID）
+         * 直接用 media_id 关联到商品（从 upload 命令获取）
+         */
+        addImagesByMediaIds: (productId: string, mediaIds: string[]) => Promise<Product>;
+    };
+    orders: {
+        /**
+         * 商户订单列表
+         */
+        list: (params?: {
+            limit?: number;
+            offset?: number;
+            status?: string;
+            start_date?: string;
+            end_date?: string;
+        }) => Promise<{
+            orders: Order[];
+            total: number;
+        }>;
+        /**
+         * 订单详情
+         */
+        get: (orderId: string) => Promise<Order>;
+        /**
+         * 标记订单已发货
+         */
+        ship: (orderId: string, data: {
+            tracking_number?: string;
+            carrier?: string;
+        }) => Promise<Order>;
+        /**
+         * 完成订单
+         */
+        complete: (orderId: string) => Promise<Order>;
+        /**
+         * 取消订单
+         */
+        cancel: (orderId: string, reason?: string) => Promise<Order>;
+        /**
+         * 标记已送达
+         */
+        markDelivered: (orderId: string) => Promise<Order>;
+    };
+    inventory: {
+        /**
+         * 获取低库存商品
+         */
+        getLowStock: (threshold?: number) => Promise<InventoryItem[]>;
+        /**
+         * 调整商品库存
+         */
+        updateStock: (productId: string, quantity: number, reason?: string) => Promise<InventoryItem>;
+        /**
+         * 查看库存变更历史
+         */
+        getHistory: (productId: string) => Promise<any[]>;
+        /**
+         * 预留库存（购物车功能）
+         */
+        reserveStock: (productId: string, quantity: number) => Promise<any>;
+    };
+    merchant: {
+        /**
+         * 获取当前商户信息
+         */
+        getProfile: () => Promise<Merchant>;
+        /**
+         * 更新商户资料
+         */
+        updateProfile: (data: Partial<Merchant>) => Promise<Merchant>;
+        /**
+         * 初始化 OAuth 用户的商户资料
+         */
+        setupProfile: (data: Partial<Merchant>) => Promise<Merchant>;
+    };
+    shipping: {
+        /**
+         * 更新物流状态
+         */
+        updateShippingStatus: (orderId: string, data: {
+            status: string;
+            note?: string;
+        }) => Promise<any>;
+        /**
+         * 获取物流历史
+         */
+        getShippingHistory: (orderId: string) => Promise<any[]>;
+        /**
+         * 添加物流备注
+         */
+        addShippingNote: (orderId: string, note: string) => Promise<any>;
+        /**
+         * 获取支持的国家列表
+         */
+        listCountries: () => Promise<any[]>;
+        /**
+         * 获取当前物流模式
+         */
+        getMode: () => Promise<{
+            mode: "fixed" | "easyship";
+        }>;
+        /**
+         * 切换物流模式
+         */
+        setMode: (mode: "fixed" | "easyship") => Promise<void>;
+    };
+    shippingFixed: {
+        /**
+         * 获取固定运费全局配置
+         */
+        getConfig: () => Promise<any>;
+        /**
+         * 更新全局配置
+         */
+        updateConfig: (data: any) => Promise<any>;
+        /**
+         * 计算订单运费
+         */
+        calculate: (data: {
+            destination_country: string;
+            postal_code?: string;
+            weight: number;
+            items?: any[];
+            merchant_id?: string;
+        }) => Promise<{
+            shipping_cost: number;
+            currency: string;
+        }>;
+        /**
+         * 获取运费区域列表
+         */
+        listZones: () => Promise<ShippingZoneListItem[]>;
+        /**
+         * 创建运费区域
+         */
+        createZone: (data: {
+            name: string;
+            countries: Array<{
+                code: string;
+            }> | string[];
+            rates?: Array<{
+                min_weight: number;
+                max_weight?: number;
+                price: number;
+                currency?: string;
+            }>;
+        }) => Promise<ShippingZone>;
+        /**
+         * 获取运费区域详情
+         */
+        getZone: (zoneId: string) => Promise<ShippingZone>;
+        /**
+         * 更新运费区域
+         */
+        updateZone: (zoneId: string, data: Partial<ShippingZone>) => Promise<ShippingZone>;
+        /**
+         * 删除运费区域
+         */
+        deleteZone: (zoneId: string) => Promise<void>;
+        /**
+         * 获取区域运费费率
+         */
+        listRates: (zoneId: string) => Promise<ShippingRate[]>;
+        /**
+         * 创建运费费率
+         */
+        createRate: (zoneId: string, data: Partial<ShippingRate>) => Promise<ShippingRate>;
+        /**
+         * 更新运费费率
+         */
+        updateRate: (zoneId: string, rateId: string, data: Partial<ShippingRate>) => Promise<ShippingRate>;
+        /**
+         * 删除运费费率
+         */
+        deleteRate: (zoneId: string, rateId: string) => Promise<void>;
+    };
+    conversations: {
+        /**
+         * 创建对话
+         */
+        create: (data: {
+            participants: Array<{
+                role: string;
+                customer_id?: string;
+                customer_email?: string;
+                customer_phone?: string;
+                customer_name?: string;
+                merchant_id?: string;
+            }>;
+            initial_message?: string;
+        }) => Promise<any>;
+        /**
+         * 获取对话列表
+         */
+        list: (params?: {
+            page?: number;
+            per_page?: number;
+            status?: string;
+        }) => Promise<any>;
+        /**
+         * 获取对话详情
+         */
+        get: (conversationId: string) => Promise<any>;
+        /**
+         * 更新对话状态
+         */
+        update: (conversationId: string, data: {
+            status?: string;
+        }) => Promise<any>;
+        /**
+         * 发送消息
+         */
+        sendMessage: (conversationId: string, data: {
+            content: string;
+            message_type?: string;
+            metadata?: any;
+        }) => Promise<any>;
+        /**
+         * 获取消息列表
+         */
+        getMessages: (conversationId: string, params?: {
+            limit?: number;
+            before?: string;
+        }) => Promise<any>;
+        /**
+         * 标记消息已读
+         */
+        markRead: (conversationId: string) => Promise<any>;
+        /**
+         * 获取对话上下文
+         */
+        getContext: (conversationId: string) => Promise<any>;
+    };
+    variants: {
+        /**
+         * 获取商品变体列表
+         */
+        list: (productId: string) => Promise<Variant[]>;
+        /**
+         * 搜索商品变体
+         */
+        search: (productId: string, criteria: any) => Promise<Variant[]>;
+        /**
+         * 创建商品变体
+         */
+        create: (productId: string, data: Partial<Variant>) => Promise<Variant>;
+        /**
+         * 获取变体详情
+         */
+        get: (productId: string, variantId: string) => Promise<Variant>;
+        /**
+         * 更新变体
+         */
+        update: (productId: string, variantId: string, data: Partial<Variant>) => Promise<Variant>;
+        /**
+         * 删除变体
+         */
+        delete: (productId: string, variantId: string) => Promise<void>;
+        /**
+         * 添加变体图片（两步流程）
+         * 1. 先上传图片到存储获取 media_id
+         * 2. 再关联 media_id 到变体
+         */
+        addImages: (masterId: string, variantId: string, imagePaths: string[]) => Promise<Variant>;
+        /**
+         * 添加变体图片（通过 Media ID）
+         * 直接用 media_id 关联到变体（从 upload 命令获取）
+         */
+        addImagesByMediaIds: (masterId: string, variantId: string, mediaIds: string[]) => Promise<Variant>;
+    };
+    refunds: {
+        /**
+         * 创建退款
+         */
+        create: (data: {
+            payment_intent_id: string;
+            amount: number;
+            reason?: string;
+        }) => Promise<any>;
+        /**
+         * 获取退款详情
+         */
+        get: (refundId: string) => Promise<any>;
+    };
+    upload: {
+        /**
+         * 上传图片
+         */
+        uploadImage: (imagePath: string) => Promise<{
+            url: string;
+            media_id?: string;
+        }>;
+        /**
+         * 上传视频
+         */
+        uploadVideo: (videoPath: string) => Promise<{
+            url: string;
+        }>;
+        /**
+         * 上传文件
+         */
+        uploadFile: (filePath: string) => Promise<{
+            url: string;
+        }>;
+    };
+    transfers: {
+        list: () => Promise<any[]>;
+        summary: () => Promise<any>;
+    };
+    i18n: {
+        /**
+         * 获取支持的语言列表
+         */
+        listLanguages: (activeOnly?: boolean) => Promise<any[]>;
+        productTranslations: {
+            list: (productId: string) => Promise<any[]>;
+            get: (productId: string, languageCode: string) => Promise<any>;
+            create: (productId: string, data: any) => Promise<any>;
+            update: (productId: string, languageCode: string, data: any) => Promise<any>;
+            delete: (productId: string, languageCode: string) => Promise<void>;
+        };
+        collectionTranslations: {
+            list: (collectionId: string) => Promise<any[]>;
+            get: (collectionId: string, languageCode: string) => Promise<any>;
+            create: (collectionId: string, data: any) => Promise<any>;
+            update: (collectionId: string, languageCode: string, data: any) => Promise<any>;
+            delete: (collectionId: string, languageCode: string) => Promise<void>;
+        };
+        merchantTranslations: {
+            list: () => Promise<any[]>;
+            get: (languageCode: string) => Promise<any>;
+            create: (data: any) => Promise<any>;
+            update: (languageCode: string, data: any) => Promise<any>;
+            delete: (languageCode: string) => Promise<void>;
+        };
+    };
+    homepage: {
+        sections: {
+            /**
+             * 列出所有 sections
+             */
+            list: () => Promise<SectionListResponse>;
+            /**
+             * 创建 section
+             */
+            create: (data: SectionCreateRequest) => Promise<HomepageSection>;
+            /**
+             * 获取单个 section
+             */
+            get: (id: string, expand?: string) => Promise<HomepageSection>;
+            /**
+             * 更新 section
+             */
+            update: (id: string, data: SectionUpdateRequest) => Promise<HomepageSection>;
+            /**
+             * 删除 section
+             */
+            delete: (id: string) => Promise<void>;
+            /**
+             * 重排序 sections
+             */
+            reorder: (moves: MoveInput[]) => Promise<SectionReorderResponse>;
+        };
+        settings: {
+            /**
+             * 更新 Banner 图片
+             */
+            updateImages: (id: string, images: Array<{
+                url: string;
+                alt: string;
+                action_type: string;
+                action_value: string | null;
+            }>) => Promise<HomepageSection>;
+            /**
+             * 更新 Collections 列表
+             */
+            updateCollections: (id: string, collection_slugs: string[]) => Promise<HomepageSection>;
+            /**
+             * 更新 Collection Products 目标集合
+             */
+            updateCollectionSlug: (id: string, collection_slug: string) => Promise<HomepageSection>;
+            /**
+             * 更新 Featured 目标
+             */
+            updateTarget: (id: string, target_type: "collection" | "product", target_handle: string) => Promise<HomepageSection>;
+            /**
+             * 通用设置补丁
+             */
+            patch: (id: string, settings: Record<string, any>) => Promise<HomepageSection>;
+        };
+        translations: {
+            /**
+             * 列出所有翻译
+             */
+            list: (sectionId: string) => Promise<TranslationListResponse>;
+            /**
+             * 创建或更新翻译 (upsert)
+             */
+            set: (sectionId: string, lang: string, data: TranslationUpdateRequest) => Promise<HomepageSectionTranslation>;
+            /**
+             * 删除翻译
+             */
+            delete: (sectionId: string, lang: string) => Promise<void>;
+        };
+    };
+    collections: {
+        /**
+         * 列出所有 collections
+         */
+        list: (params?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<CollectionListResponse>;
+        /**
+         * 创建 collection
+         */
+        create: (data: CollectionCreateRequest) => Promise<Collection>;
+        /**
+         * 获取单个 collection
+         */
+        get: (id: string) => Promise<Collection>;
+        /**
+         * 更新 collection
+         */
+        update: (id: string, data: CollectionUpdateRequest) => Promise<Collection>;
+        /**
+         * 删除 collection
+         */
+        delete: (id: string) => Promise<void>;
+        /**
+         * 添加商品到 collection
+         */
+        addProducts: (id: string, productIds: string[]) => Promise<void>;
+        /**
+         * 从 collection 移除商品
+         * Note: Backend API 不支持批量删除，需要对每个产品发送单独的 DELETE 请求
+         */
+        removeProducts: (id: string, productIds: string[]) => Promise<void>;
+        /**
+         * 列出 collection 中的商品
+         */
+        listProducts: (id: string, params?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<CollectionProductsResponse>;
+    };
+    tags: {
+        /**
+         * 列出所有 tags
+         */
+        list: () => Promise<TagListResponse>;
+        /**
+         * 创建 tag
+         */
+        create: (name: string) => Promise<Tag>;
+        /**
+         * 删除 tag
+         */
+        delete: (name: string) => Promise<void>;
+        /**
+         * 获取 tag 统计信息
+         */
+        stats: (name: string) => Promise<TagStatsResponse>;
+    };
+}
+export declare const commerceApi: CommerceApiClient;
+export type { Product, Order, OrderItem, InventoryItem, Merchant, ShippingZone, ShippingRate, Variant, HomepageSection, HomepageSectionTranslation, MoveInput, SectionCreateRequest, SectionUpdateRequest, SectionListResponse, SectionReorderResponse, BannerImagesUpdateRequest, CollectionsUpdateRequest, FeaturedTargetUpdateRequest, TranslationUpdateRequest, TranslationListResponse, Collection, CollectionCreateRequest, CollectionUpdateRequest, CollectionListResponse, CollectionResponse, CollectionProductsRequest, CollectionProductsResponse, Tag, TagListResponse, TagResponse, TagStatsResponse, };
+//# sourceMappingURL=commerce.d.ts.map