@congminh1254/shopee-sdk 0.9.0 → 1.0.0

package/README.md

@@ -1,61 +1,203 @@
 # Shopee SDK
 
-A TypeScript SDK for interacting with the Shopee Open API, maintained by the community.
+[![CI](https://github.com/congminh1254/shopee-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/congminh1254/shopee-sdk/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/congminh1254/shopee-sdk/badge.svg?branch=main)](https://coveralls.io/github/congminh1254/shopee-sdk?branch=main)
+[![npm version](https://badge.fury.io/js/@congminh1254%2Fshopee-sdk.svg)](https://badge.fury.io/js/@congminh1254%2Fshopee-sdk)
+[![Node.js Version](https://img.shields.io/node/v/@congminh1254/shopee-sdk.svg)](https://www.npmjs.com/package/@congminh1254/shopee-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+🎉 **The most complete, production-ready TypeScript SDK for Shopee Open API** 🎉
+
+Build powerful Shopee integrations with confidence using our fully-featured SDK that covers **100% of Shopee's API endpoints**. Trusted by developers, built by the community.
+
+## 📚 Documentation
+
+**[Complete Documentation](./docs/README.md)** - Comprehensive guides and API references
+
+### Quick Links
+
+**Getting Started:**
+- [Setup Guide](./docs/guides/setup.md) - Installation and configuration
+- [Authentication](./docs/guides/authentication.md) - OAuth flow and token management
+- [Token Storage](./docs/guides/token-storage.md) - Managing access tokens
+- [Proxy Configuration](./docs/guides/proxy.md) - Using HTTP/HTTPS proxies
+
+**API Managers:**
+- [AuthManager](./docs/managers/auth.md) - Authentication operations
+- [ProductManager](./docs/managers/product.md) - Product catalog management
+- [OrderManager](./docs/managers/order.md) - Order processing
+- [LogisticsManager](./docs/managers/logistics.md) - Shipping operations
+- [PaymentManager](./docs/managers/payment.md) - Payment information
+- [VoucherManager](./docs/managers/voucher.md) - Discount management
+- [PushManager](./docs/managers/push.md) - Webhooks and notifications
+- [PublicManager](./docs/managers/public.md) - Public API endpoints
+- [AdsManager](./docs/managers/ads.md) - Advertising campaigns
+- [AccountHealthManager](./docs/managers/account-health.md) - Performance metrics
+- [ShopManager](./docs/managers/shop.md) - Shop information and settings
+- [MediaManager](./docs/managers/media.md) - Image and video upload
+- [MediaSpaceManager](./docs/managers/media-space.md) - Media uploads (images and videos)
+- [MerchantManager](./docs/managers/merchant.md) - Merchant information and warehouses
+- [GlobalProductManager](./docs/managers/global-product.md) - Global product management
+- [FirstMileManager](./docs/managers/first-mile.md) - First mile logistics
+- [DiscountManager](./docs/managers/discount.md) - Discount campaigns
+- [BundleDealManager](./docs/managers/bundle-deal.md) - Bundle deal promotions
+- [AddOnDealManager](./docs/managers/add-on-deal.md) - Add-on deal promotions
+- [ShopFlashSaleManager](./docs/managers/shop-flash-sale.md) - Flash sale campaigns
+- [FollowPrizeManager](./docs/managers/follow-prize.md) - Follow prize activities
+- [TopPicksManager](./docs/managers/top-picks.md) - Top picks collections
+- [ShopCategoryManager](./docs/managers/shop-category.md) - Shop category management
+- [ReturnsManager](./docs/managers/returns.md) - Return and refund management
+- [SbsManager](./docs/managers/sbs.md) - Shopee Business Services (SBS) warehouse inventory
+- [FbsManager](./docs/managers/fbs.md) - Fulfillment by Shopee operations
+- [LivestreamManager](./docs/managers/livestream.md) - Live streaming features
 
 ## Installation
 
 ```bash
-npm install shopee-sdk
+npm install @congminh1254/shopee-sdk
 ```
 
-## Usage
+**Requirements:** Node.js >= 18.0.0
+
+### What You Get
+✅ Complete TypeScript definitions for all 27 API managers  
+✅ Automatic token refresh and management  
+✅ Built-in error handling and retry logic  
+✅ Zero dependencies (except node-fetch)  
+✅ Full documentation and examples  
+
+## Quick Start
+
+Get up and running in minutes! Here's how easy it is to integrate with Shopee:
 
 ```typescript
-import { ShopeeClient } from "shopee-sdk";
+import { ShopeeSDK, ShopeeRegion } from '@congminh1254/shopee-sdk';
 
-// Initialize the client
-const client = new ShopeeClient({
+// 1. Initialize the SDK with your credentials
+const sdk = new ShopeeSDK({
   partner_id: 123456,
-  partner_key: "your-partner-key",
-  base_url: "https://partner.test-stable.shopeemobile.com", // For sandbox
-  // base_url: 'https://partner.shopeemobile.com', // For production
+  partner_key: 'your-partner-key',
+  region: ShopeeRegion.GLOBAL,
+  shop_id: 789012, // Optional for shop-specific operations
 });
 
-// Authenticate (if working with shop-level APIs)
-await client.auth.getToken({
-  code: "authorization-code",
-  shop_id: 123456,
-});
+// 2. Authenticate your shop (OAuth flow)
+const authUrl = sdk.getAuthorizationUrl('https://your-app.com/callback');
+console.log('Visit:', authUrl);
+
+// After user authorizes, exchange code for token (automatic token storage!)
+await sdk.authenticateWithCode('auth-code-from-callback');
+
+// 3. Start using the API - it's that simple!
 
-// Example: Get product list
-const products = await client.product.getItemList({
+// Manage your products
+const products = await sdk.product.getItemList({
   offset: 0,
-  page_size: 10,
+  page_size: 20,
 });
 
-// Example: Add a voucher
-const voucher = await client.voucher.addVoucher({
-  voucher_name: "Special Discount",
-  voucher_code: "SAVE10",
-  start_time: Math.floor(Date.now() / 1000),
-  end_time: Math.floor(Date.now() / 1000) + 7 * 24 * 60 * 60, // 7 days
-  voucher_type: 1, // shop voucher
-  reward_type: 1, // fixed amount
-  usage_quantity: 100,
-  min_basket_price: 20,
-  discount_amount: 10,
+// Process orders
+const orders = await sdk.order.getOrderList({
+  time_range_field: 'create_time',
+  time_from: Math.floor(Date.now() / 1000) - 86400,
+  time_to: Math.floor(Date.now() / 1000),
+  page_size: 50,
 });
 
-// Example: Get lost push messages (partner-level API, no auth required)
-const lostMessages = await client.push.getLostPushMessage();
-```
+// Track shipments
+const shipping = await sdk.logistics.getShippingParameter({
+  order_sn: '220615ABCDEF',
+});
 
-## Features
+// Handle returns
+const returns = await sdk.returns.getReturnList({
+  page_size: 20,
+});
+
+// And much more - all with full TypeScript support! 🎉
+```
 
-- TypeScript support with full type definitions
-- Support for all Shopee Open API endpoints
-- Authentication flow helpers
-- Automatic token refresh
+**That's it!** The SDK handles token refresh, request signing, error handling, and more automatically.
+
+See the [Setup Guide](./docs/guides/setup.md) and [Authentication Guide](./docs/guides/authentication.md) for detailed instructions.
+
+## Why Choose This SDK?
+
+### 🚀 Production-Ready & Battle-Tested
+- **75%+ test coverage** with 86 comprehensive tests - ensuring reliability in production
+- **Zero compromises** - Every Shopee API endpoint is implemented and documented
+- **Type-safe** - Full TypeScript definitions prevent errors before they happen
+- **Actively maintained** - Regular updates to stay in sync with Shopee API changes
+
+### 💪 Complete API Coverage - All 27 Managers Implemented
+Unlike other SDKs with partial coverage, we provide **complete access** to every Shopee API:
+
+**Core Commerce:**
+- 📦 **ProductManager** - Full product catalog management with 55+ endpoints
+- 🛒 **OrderManager** - Complete order processing and fulfillment workflow
+- 🚚 **LogisticsManager** - Comprehensive shipping and tracking operations
+- 💳 **PaymentManager** - Payment and escrow information management
+
+**Marketing & Promotions:**
+- 🎟️ **VoucherManager** - Discount voucher campaigns
+- 💥 **DiscountManager** - Discount promotion campaigns
+- 🎁 **BundleDealManager** - Bundle deal promotions
+- ➕ **AddOnDealManager** - Add-on deal promotions
+- ⚡ **ShopFlashSaleManager** - Flash sale campaigns
+- 🎯 **FollowPrizeManager** - Follow prize activities
+- ⭐ **TopPicksManager** - Top picks product collections
+
+**Store Management:**
+- 🏪 **ShopManager** - Shop information and profile management
+- 🏢 **MerchantManager** - Merchant information, warehouses, and multi-shop management
+- 📂 **ShopCategoryManager** - Shop category organization
+- 🖼️ **MediaManager** & **MediaSpaceManager** - Image and video upload operations
+
+**Advanced Features:**
+- 🔐 **AuthManager** - OAuth flow and token lifecycle management
+- 📢 **PushManager** - Webhooks and real-time notifications
+- 🌍 **GlobalProductManager** - Cross-border product management
+- 🔄 **ReturnsManager** - Return and refund request handling
+- 📊 **AdsManager** - Advertising campaign management
+- 📈 **AccountHealthManager** - Performance metrics and analytics
+- 🌐 **PublicManager** - Public API endpoints (no auth required)
+- 📍 **FirstMileManager** - First mile logistics operations
+- 🏭 **SbsManager** - Shopee Business Services warehouse inventory
+- 📦 **FbsManager** - Fulfillment by Shopee operations
+- 📹 **LivestreamManager** - Live streaming features
+
+### ✨ Developer Experience First
+- **Intuitive API design** - Clean, consistent interfaces across all managers
+- **Automatic token refresh** - Built-in token management, never worry about expiration
+- **Flexible storage** - File-based storage included, easy to implement custom solutions
+- **Multi-region support** - Works seamlessly across all 12 Shopee regions
+- **Proxy support** - Enterprise-ready HTTP/HTTPS proxy configuration
+- **Comprehensive docs** - Detailed guides and real-world examples for every feature
+- **Full type safety** - Complete TypeScript definitions for autocomplete and error prevention
+
+## Real-World Use Cases
+
+This SDK is perfect for building:
+
+- 🏪 **Multi-channel E-commerce Platforms** - Sync inventory, orders, and products across multiple sales channels
+- 📊 **Analytics Dashboards** - Track sales performance, customer behavior, and business metrics
+- 🤖 **Automation Tools** - Automate order processing, inventory updates, and customer communications
+- 🔄 **ERP Integrations** - Connect Shopee with your existing business systems
+- 📱 **Mobile Apps** - Build native mobile experiences for shop management
+- 🎯 **Marketing Automation** - Manage promotions, vouchers, and advertising campaigns programmatically
+- 📦 **Inventory Management Systems** - Real-time stock tracking across warehouses
+- 🚀 **Custom Storefronts** - Create unique shopping experiences powered by Shopee's infrastructure
+
+## Migrating from Other SDKs?
+
+Switching is easy! Our SDK offers:
+- **More complete coverage** - Every endpoint is implemented, not just the basics
+- **Better TypeScript support** - Full type safety from end to end
+- **Simpler API** - Intuitive, well-organized manager classes
+- **Active maintenance** - Regular updates and community support
+- **Production-ready** - Battle-tested with comprehensive test coverage
+
+Check our [Migration Guide](./docs/guides/setup.md) to get started.
 
 ## Contributing
 

package/lib/fetch.js

@@ -1,6 +1,14 @@
 import fetch, { Headers } from "node-fetch";
 import { ShopeeApiError, ShopeeSdkError } from "./errors.js";
 import { generateSignature } from "./utils/signature.js";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+// Read version from package.json
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJson = JSON.parse(readFileSync(join(__dirname, "../package.json"), "utf-8"));
+const SDK_VERSION = packageJson.version;
 export class ShopeeFetch {
     static async fetch(config, path, options = {}) {
         const { method = "GET", params = {}, body } = options;
@@ -53,6 +61,7 @@ export class ShopeeFetch {
         // Prepare headers
         const headers = new Headers();
         headers.set("Content-Type", "application/json");
+        headers.set("User-Agent", `congminh1254/shopee-sdk/v${SDK_VERSION}`);
         if (options.headers) {
             Object.entries(options.headers).forEach(([key, value]) => {
                 headers.set(key, value);
@@ -95,6 +104,10 @@ export class ShopeeFetch {
         }
         catch (error) {
             if (error instanceof Error) {
+                // Re-throw our custom errors as-is
+                if (error instanceof ShopeeApiError || error instanceof ShopeeSdkError) {
+                    throw error;
+                }
                 if (error.name === "FetchError") {
                     // Network error
                     throw new ShopeeSdkError(`Network error: ${error.message}`);

package/lib/fetch.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAyB,OAAO,EAAe,MAAM,YAAY,CAAC;AAGhF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,MAAM,OAAO,WAAW;IACf,MAAM,CAAC,KAAK,CAAC,KAAK,CACvB,MAAoB,EACpB,IAAY,EACZ,UAAwB,EAAE;QAE1B,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,GAAG,IAAI,EAAE,CAAC,CAAC;QACjD,0BAA0B;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAChD,IAAI,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE;YACpD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC5B,GAAG,CAAC,QAAQ;YACZ,SAAS,CAAC,QAAQ,EAAE;SACrB,CAAC,CAAC;QAEH,uBAAuB;QACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5F,MAAM,SAAS,GAAG;YAChB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,SAAS;YACT,GAAG,MAAM;SACV,CAAC;QAEF,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;YAC7C,IAAI,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBACvD,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;YAC3C,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,cAAc,CAAC,uBAAuB,CAAC,CAAC;YACpD,CAAC;YACD,UAAU,GAAG;gBACX,YAAY,EAAE,KAAK,EAAE,YAAY;gBACjC,OAAO,EAAE,KAAK,EAAE,OAAO;aACxB,CAAC;YACF,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE;gBAChD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAC5B,GAAG,CAAC,QAAQ;gBACZ,SAAS,CAAC,QAAQ,EAAE;gBACpB,KAAK,EAAE,YAAY;gBACnB,KAAK,EAAE,OAAQ,CAAC,QAAQ,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACxF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBACrB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7C,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,kBAAkB;QAClB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAChD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACvD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAe,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,wBAAwB;QACxB,MAAM,cAAc,GAAgB;YAClC,MAAM;YACN,OAAO,EAAE,OAAiC;YAC1C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAa,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;YACvE,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC1D,MAAM,YAAY,GAChB,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC9C,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE;gBACvB,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAE5B,IAAI,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrD,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;oBACvB,oCAAoC;oBACpC,IAAI,YAAY,CAAC,KAAK,KAAK,uBAAuB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;wBACnE,IAAI,CAAC;4BACH,sCAAsC;4BACtC,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;4BACjC,uCAAuC;4BACvC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;wBAC3C,CAAC;wBAAC,OAAO,YAAY,EAAE,CAAC;4BACtB,6CAA6C;4BAC7C,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;wBAC1D,CAAC;oBACH,CAAC;oBACD,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;gBAC1D,CAAC;gBAED,MAAM,IAAI,GAAG,YAAiB,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,IAAI,cAAc,CAAC,0BAA0B,YAAY,KAAK,YAAY,EAAE,CAAC,CAAC;QACtF,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBAChC,gBAAgB;oBAChB,MAAM,IAAI,cAAc,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9D,CAAC;gBACD,eAAe;gBACf,MAAM,IAAI,cAAc,CAAC,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,IAAI,cAAc,CAAC,wBAAwB,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAyB,OAAO,EAAe,MAAM,YAAY,CAAC;AAGhF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAErC,iCAAiC;AACjC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1F,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC;AAExC,MAAM,OAAO,WAAW;IACf,MAAM,CAAC,KAAK,CAAC,KAAK,CACvB,MAAoB,EACpB,IAAY,EACZ,UAAwB,EAAE;QAE1B,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,GAAG,IAAI,EAAE,CAAC,CAAC;QACjD,0BAA0B;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAChD,IAAI,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE;YACpD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC5B,GAAG,CAAC,QAAQ;YACZ,SAAS,CAAC,QAAQ,EAAE;SACrB,CAAC,CAAC;QAEH,uBAAuB;QACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5F,MAAM,SAAS,GAAG;YAChB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,SAAS;YACT,GAAG,MAAM;SACV,CAAC;QAEF,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;YAC7C,IAAI,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBACvD,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;YAC3C,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,cAAc,CAAC,uBAAuB,CAAC,CAAC;YACpD,CAAC;YACD,UAAU,GAAG;gBACX,YAAY,EAAE,KAAK,EAAE,YAAY;gBACjC,OAAO,EAAE,KAAK,EAAE,OAAO;aACxB,CAAC;YACF,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE;gBAChD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAC5B,GAAG,CAAC,QAAQ;gBACZ,SAAS,CAAC,QAAQ,EAAE;gBACpB,KAAK,EAAE,YAAY;gBACnB,KAAK,EAAE,OAAQ,CAAC,QAAQ,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACxF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBACrB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7C,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,kBAAkB;QAClB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,4BAA4B,WAAW,EAAE,CAAC,CAAC;QACrE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACvD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAe,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,wBAAwB;QACxB,MAAM,cAAc,GAAgB;YAClC,MAAM;YACN,OAAO,EAAE,OAAiC;YAC1C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAa,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;YACvE,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC1D,MAAM,YAAY,GAChB,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC9C,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE;gBACvB,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAE5B,IAAI,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrD,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;oBACvB,oCAAoC;oBACpC,IAAI,YAAY,CAAC,KAAK,KAAK,uBAAuB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;wBACnE,IAAI,CAAC;4BACH,sCAAsC;4BACtC,MAAM,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC;4BACjC,uCAAuC;4BACvC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;wBAC3C,CAAC;wBAAC,OAAO,YAAY,EAAE,CAAC;4BACtB,6CAA6C;4BAC7C,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;wBAC1D,CAAC;oBACH,CAAC;oBACD,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;gBAC1D,CAAC;gBAED,MAAM,IAAI,GAAG,YAAiB,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,IAAI,cAAc,CAAC,0BAA0B,YAAY,KAAK,YAAY,EAAE,CAAC,CAAC;QACtF,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,mCAAmC;gBACnC,IAAI,KAAK,YAAY,cAAc,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;oBACvE,MAAM,KAAK,CAAC;gBACd,CAAC;gBACD,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBAChC,gBAAgB;oBAChB,MAAM,IAAI,cAAc,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9D,CAAC;gBACD,eAAe;gBACf,MAAM,IAAI,cAAc,CAAC,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,IAAI,cAAc,CAAC,wBAAwB,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF"}

package/lib/managers/add-on-deal.manager.d.ts

@@ -0,0 +1,140 @@
+import { ShopeeConfig } from "../sdk.js";
+import { BaseManager } from "./base.manager.js";
+import { AddAddOnDealParams, AddAddOnDealResponse, AddAddOnDealMainItemParams, AddAddOnDealMainItemResponse, AddAddOnDealSubItemParams, AddAddOnDealSubItemResponse, DeleteAddOnDealParams, DeleteAddOnDealResponse, DeleteAddOnDealMainItemParams, DeleteAddOnDealMainItemResponse, DeleteAddOnDealSubItemParams, DeleteAddOnDealSubItemResponse, EndAddOnDealParams, EndAddOnDealResponse, GetAddOnDealParams, GetAddOnDealResponse, GetAddOnDealListParams, GetAddOnDealListResponse, GetAddOnDealMainItemParams, GetAddOnDealMainItemResponse, GetAddOnDealSubItemParams, GetAddOnDealSubItemResponse, UpdateAddOnDealParams, UpdateAddOnDealResponse, UpdateAddOnDealMainItemParams, UpdateAddOnDealMainItemResponse, UpdateAddOnDealSubItemParams, UpdateAddOnDealSubItemResponse } from "../schemas/add-on-deal.js";
+export declare class AddOnDealManager extends BaseManager {
+    constructor(config: ShopeeConfig);
+    /**
+     * Create a new add-on deal activity
+     * @param {AddAddOnDealParams} params - Parameters for creating a new add-on deal
+     * @returns {Promise<AddAddOnDealResponse>} The response containing the created add-on deal ID
+     *
+     * Note: A maximum of 1000 add-on deals can be created.
+     * The start time must be 1 hour later than current time.
+     * The end time must be 1 hour later than start time.
+     */
+    addAddOnDeal(params: AddAddOnDealParams): Promise<AddAddOnDealResponse>;
+    /**
+     * Add main items to an existing add-on deal activity
+     * @param {AddAddOnDealMainItemParams} params - Parameters for adding main items to an add-on deal
+     * @returns {Promise<AddAddOnDealMainItemResponse>} The response containing the list of added main items
+     *
+     * Main items are the products that customers must purchase to be eligible for the add-on deal.
+     */
+    addAddOnDealMainItem(params: AddAddOnDealMainItemParams): Promise<AddAddOnDealMainItemResponse>;
+    /**
+     * Add sub items (discounted or gift items) to an existing add-on deal activity
+     * @param {AddAddOnDealSubItemParams} params - Parameters for adding sub items to an add-on deal
+     * @returns {Promise<AddAddOnDealSubItemResponse>} The response containing any failed sub items
+     *
+     * Sub items are the products offered at a discount or as gifts when customers purchase main items.
+     * The response includes a list of items that failed to be added with error details.
+     */
+    addAddOnDealSubItem(params: AddAddOnDealSubItemParams): Promise<AddAddOnDealSubItemResponse>;
+    /**
+     * Delete an existing add-on deal activity
+     * @param {DeleteAddOnDealParams} params - Parameters for deleting an add-on deal
+     * @returns {Promise<DeleteAddOnDealResponse>} The response containing the deleted add-on deal ID
+     *
+     * Note: Can only delete upcoming add-on deals that haven't started yet.
+     * Will return an error if attempting to delete an add-on deal that has already started.
+     */
+    deleteAddOnDeal(params: DeleteAddOnDealParams): Promise<DeleteAddOnDealResponse>;
+    /**
+     * Delete main items from an existing add-on deal activity
+     * @param {DeleteAddOnDealMainItemParams} params - Parameters for deleting main items from an add-on deal
+     * @returns {Promise<DeleteAddOnDealMainItemResponse>} The response containing any failed item deletions
+     *
+     * The response includes:
+     * - add_on_deal_id: The ID of the add-on deal
+     * - failed_item_id_list: List of item IDs that failed to be deleted
+     */
+    deleteAddOnDealMainItem(params: DeleteAddOnDealMainItemParams): Promise<DeleteAddOnDealMainItemResponse>;
+    /**
+     * Delete sub items from an existing add-on deal activity
+     * @param {DeleteAddOnDealSubItemParams} params - Parameters for deleting sub items from an add-on deal
+     * @returns {Promise<DeleteAddOnDealSubItemResponse>} The response containing any failed sub item deletions
+     *
+     * The response includes a list of sub items that failed to be deleted with error details.
+     * Note: At least one sub item should remain in the add-on deal.
+     */
+    deleteAddOnDealSubItem(params: DeleteAddOnDealSubItemParams): Promise<DeleteAddOnDealSubItemResponse>;
+    /**
+     * End an ongoing add-on deal activity immediately
+     * @param {EndAddOnDealParams} params - Parameters for ending an add-on deal
+     * @returns {Promise<EndAddOnDealResponse>} The response containing the ended add-on deal ID
+     *
+     * Note: Can only end add-on deals that are currently ongoing/active.
+     * Will return an error if attempting to end an upcoming or expired add-on deal.
+     */
+    endAddOnDeal(params: EndAddOnDealParams): Promise<EndAddOnDealResponse>;
+    /**
+     * Get detailed information about an add-on deal activity
+     * @param {GetAddOnDealParams} params - Parameters for getting add-on deal details
+     * @returns {Promise<GetAddOnDealResponse>} The response containing comprehensive add-on deal information
+     *
+     * The response includes:
+     * - Basic add-on deal details (ID, name, start/end time, etc.)
+     * - Promotion type and configuration
+     * - Purchase limits and requirements
+     * - Sub item display priority
+     * - Source information
+     */
+    getAddOnDeal(params: GetAddOnDealParams): Promise<GetAddOnDealResponse>;
+    /**
+     * Get a list of add-on deal activities with pagination
+     * @param {GetAddOnDealListParams} params - Parameters for retrieving add-on deal list
+     * @param {AddOnDealPromotionStatus} params.promotion_status - Filter by promotion status (all, ongoing, upcoming, expired)
+     * @param {number} [params.page_no] - Page number to retrieve (default: 1, max: 1000)
+     * @param {number} [params.page_size] - Number of items per page (default: 100, max: 100)
+     * @returns {Promise<GetAddOnDealListResponse>} The response containing a paginated list of add-on deals
+     *
+     * The response includes:
+     * - add_on_deal_list: List of add-on deals with full details
+     * - more: Boolean indicating if there are more pages
+     */
+    getAddOnDealList(params: GetAddOnDealListParams): Promise<GetAddOnDealListResponse>;
+    /**
+     * Get main items in an add-on deal activity
+     * @param {GetAddOnDealMainItemParams} params - Parameters for getting main items
+     * @returns {Promise<GetAddOnDealMainItemResponse>} The response containing the list of main items
+     *
+     * Main items are the products that customers must purchase to be eligible for the add-on deal.
+     */
+    getAddOnDealMainItem(params: GetAddOnDealMainItemParams): Promise<GetAddOnDealMainItemResponse>;
+    /**
+     * Get sub items (discounted or gift items) in an add-on deal activity
+     * @param {GetAddOnDealSubItemParams} params - Parameters for getting sub items
+     * @returns {Promise<GetAddOnDealSubItemResponse>} The response containing the list of sub items
+     *
+     * Sub items are the products offered at a discount or as gifts when customers purchase main items.
+     */
+    getAddOnDealSubItem(params: GetAddOnDealSubItemParams): Promise<GetAddOnDealSubItemResponse>;
+    /**
+     * Update an existing add-on deal activity
+     * @param {UpdateAddOnDealParams} params - Parameters for updating an add-on deal
+     * @returns {Promise<UpdateAddOnDealResponse>} The response containing the updated add-on deal information
+     *
+     * Note: For ongoing add-on deals, update capabilities may be limited.
+     * Only certain fields can be modified depending on the add-on deal status.
+     * The start time of upcoming add-on deals cannot be shortened.
+     * Promotion end time can only be changed to an earlier timing.
+     */
+    updateAddOnDeal(params: UpdateAddOnDealParams): Promise<UpdateAddOnDealResponse>;
+    /**
+     * Update main items in an existing add-on deal activity
+     * @param {UpdateAddOnDealMainItemParams} params - Parameters for updating main items
+     * @returns {Promise<UpdateAddOnDealMainItemResponse>} The response containing the updated main items
+     *
+     * Main items are the products that customers must purchase to be eligible for the add-on deal.
+     */
+    updateAddOnDealMainItem(params: UpdateAddOnDealMainItemParams): Promise<UpdateAddOnDealMainItemResponse>;
+    /**
+     * Update sub items in an existing add-on deal activity
+     * @param {UpdateAddOnDealSubItemParams} params - Parameters for updating sub items
+     * @returns {Promise<UpdateAddOnDealSubItemResponse>} The response containing any failed sub item updates
+     *
+     * Sub items are the products offered at a discount or as gifts when customers purchase main items.
+     * The response includes a list of sub items that failed to be updated with error details.
+     */
+    updateAddOnDealSubItem(params: UpdateAddOnDealSubItemParams): Promise<UpdateAddOnDealSubItemResponse>;
+}