@applite/js-sdk 0.0.12 → 0.0.13

package/README.md

@@ -1,8 +1,8 @@
 # @applite/js-sdk
 
-A comprehensive JavaScript/TypeScript SDK for interacting with the Applite Customer API. This library provides a structured, typed interface to manage application data, e-commerce operations, and service bookings.
+A comprehensive JavaScript/TypeScript SDK for interacting with the Applite API. This library provides a typed interface to manage application data, e-commerce operations, service bookings, and more.
 
-> **Full Documentation**: For detailed API references and guides, visit [docs.appliteui.com/sdk](https://docs.appliteui.com/sdk).
+> **Full Documentation**: For detailed API references and guides, visit [docs.appliteui.com](https://docs.appliteui.com).
 
 ## Installation
 
@@ -16,239 +16,487 @@ yarn add @applite/js-sdk
 
 ## Quick Start
 
-Initialize the client with your API base URL (optional if using relative paths in a same-origin environment).
-
 ```ts
 import { AppliteUI } from "@applite/js-sdk";
 
 const client = new AppliteUI({
   baseUrl: "https://api.applite.com", // Optional: Defaults to relative path
 });
+
+// Authenticate a customer
+const user = await client.app.customer.auth({
+  appId: "app_123",
+  apiKey: "your_api_key",
+  fullname: "John Doe",
+  telephone: "+2250700000000",
+});
 ```
 
 ## Core Concepts
 
-### Authentication & Context
+### Authentication
 
-Every request requires two key parameters to identify the context and authorize the user:
+Every request requires two key parameters:
 
-- **`appId`**: The unique identifier of your application (e.g., used in URL paths).
-- **`apiKey`**: The secret key used to authenticate requests.
+- **`appId`**: The unique identifier of your application
+- **`apiKey`**: The secret key used to authenticate requests
 
 ### Method Signature
 
-All SDK methods accept a **single object** containing all parameters. This ensures better type safety and extensibility.
+All SDK methods accept a single object containing all parameters:
 
 ```ts
-// Example signature
-await client.module.resource.action({
+await client.module.method({
   appId: "...",
   apiKey: "...",
   ...specificParams,
 });
 ```
 
-## Architecture
+### Response Structure
 
-The SDK is organized into three main modules:
+```ts
+// Success
+{ success: true, data: {...} }
 
-1.  **App Module (`client.app`)**: Core application logic (Customers, Stats, Finance).
-2.  **Store Module (`client.app.store`)**: E-commerce functionality (Products, Orders, Sellers).
-3.  **Multi-Service Module (`client.app.multiService`)**: Service booking and appointments.
+// Error
+{ success: false, error: "message" }
+```
 
 ---
 
-## App Management (`client.app`)
+## API Reference
+
+### Common Module (`client.app`)
+
+#### Customer API (`client.app.customer`)
+
+| Method | Description |
+|--------|-------------|
+| `auth(params)` | Authenticate or register a customer |
+| `check(params)` | Check if a customer exists by phone |
+| `list(params)` | List customers with optional filtering |
+| `get(params)` | Get customer details by ID |
+| `update(params)` | Update customer profile |
+| `block(params)` | Block or unblock a customer |
+| `delete(params)` | Delete a customer |
+| `selfDelete(params)` | Customer self-deletion |
+
+#### Info API (`client.app.info`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List all apps |
+| `create(params)` | Create a new app |
+| `getBySlug(params)` | Get app by slug |
+| `getById(params)` | Get app by ID |
+| `update(params)` | Update app details |
+| `updateModules(params)` | Update app modules |
+| `toggleModule(params)` | Toggle a module on/off |
+
+#### Address API (`client.app.address`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List addresses |
+| `create(params)` | Create an address |
+| `update(params)` | Update an address |
+| `delete(params)` | Delete an address |
+| `getById(params)` | Get address by ID |
+
+#### Stats API (`client.app.stats`)
+
+| Method | Description |
+|--------|-------------|
+| `create(params)` | Create a statistic entry |
+| `get(params)` | Get statistic value |
+
+#### Finance API (`client.app.finance`)
+
+| Method | Description |
+|--------|-------------|
+| `balance(params)` | Get account balance |
+| `listTransactions(params)` | List transactions |
+
+#### Welcome Item API (`client.app.welcomeItem`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List welcome items |
+| `create(params)` | Create a welcome item |
+| `update(params)` | Update a welcome item |
+| `delete(params)` | Delete a welcome item |
+
+#### User API (`client.user`)
+
+| Method | Description |
+|--------|-------------|
+| `signup(params)` | Register a new user |
+| `signin(params)` | Sign in a user |
+| `get(params)` | Get user by ID |
+| `update(params)` | Update user profile |
+| `delete(params)` | Delete a user |
+| `editCredentials(params)` | Edit user credentials |
+| `verifyPassword(params)` | Verify user password |
+| `setNotification(params)` | Set notification preferences |
+
+#### Notification Token API (`client.app.notificationToken`)
+
+| Method | Description |
+|--------|-------------|
+| `register(params)` | Register a push token |
+| `unregister(params)` | Unregister a push token |
+
+#### Notification API (`client.notification`)
+
+| Method | Description |
+|--------|-------------|
+| `getFirebaseConfig(params)` | Get Firebase config |
+| `setFirebaseConfig(params)` | Set Firebase config |
+| `deleteFirebaseConfig(params)` | Delete Firebase config |
+| `getTemplates(params)` | Get notification templates |
+| `setTemplate(params)` | Set a notification template |
+| `deleteTemplate(params)` | Delete a notification template |
+| `getLogs(params)` | Get notification logs |
+
+#### Webhook API (`client.webhook`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List webhooks |
+| `set(params)` | Create or update a webhook |
+| `delete(params)` | Delete a webhook |
+| `getLogs(params)` | Get webhook logs |
 
-Manage your application's users and core settings.
+---
 
-### Customers
+### Store Module (`client.app.store`)
+
+#### Product API (`client.app.store.product`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List products |
+| `create(params)` | Create a product |
+| `get(params)` | Get product by ID |
+| `update(params)` | Update a product |
+| `delete(params)` | Delete a product |
+
+#### Order API (`client.app.store.order`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List orders |
+| `create(params)` | Create an order |
+| `get(params)` | Get order by ID |
+| `update(params)` | Update an order |
+
+#### Category API (`client.app.store.category`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List categories |
+| `create(params)` | Create a category |
+| `get(params)` | Get category by ID |
+| `update(params)` | Update a category |
+| `delete(params)` | Delete a category |
+
+#### Badge API (`client.app.store.badge`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List badges |
+| `create(params)` | Create a badge |
+| `update(params)` | Update a badge |
+| `delete(params)` | Delete a badge |
+
+#### Collection API (`client.app.store.collection`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List collections |
+| `create(params)` | Create a collection |
+| `get(params)` | Get collection by ID |
+| `update(params)` | Update a collection |
+| `delete(params)` | Delete a collection |
+
+#### Discount API (`client.app.store.discount`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List discounts |
+| `create(params)` | Create a discount |
+| `get(params)` | Get discount by ID |
+| `update(params)` | Update a discount |
+| `delete(params)` | Delete a discount |
+| `check(params)` | Check discount validity |
+
+#### Option API (`client.app.store.option`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List options |
+| `create(params)` | Create an option |
+| `update(params)` | Update an option |
+| `delete(params)` | Delete an option |
+
+#### Seller API (`client.app.store.seller`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List sellers |
+| `create(params)` | Create a seller |
+| `get(params)` | Get seller by ID |
+| `update(params)` | Update a seller |
+| `delete(params)` | Delete a seller |
+
+#### Shipping API (`client.app.store.shipping`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List shipping profiles |
+| `create(params)` | Create a shipping profile |
+| `update(params)` | Update a shipping profile |
+| `delete(params)` | Delete a shipping profile |
+
+#### Tag API (`client.app.store.tag`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List tags |
+| `create(params)` | Create a tag |
+| `update(params)` | Update a tag |
+| `delete(params)` | Delete a tag |
+
+#### Tax API (`client.app.store.tax`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List tax configurations |
+| `create(params)` | Create a tax configuration |
+| `update(params)` | Update a tax configuration |
+| `delete(params)` | Delete a tax configuration |
 
-Manage end-users of your application.
+---
 
-#### Authenticate / Register a Customer
+### Multi-Service Module (`client.app.multiService`)
+
+#### Company API (`client.app.multiService.company`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List companies |
+| `create(params)` | Create a company |
+| `get(params)` | Get company by ID |
+| `update(params)` | Update a company |
+| `delete(params)` | Delete a company |
+
+#### Service API (`client.app.multiService.service`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List services |
+| `create(params)` | Create a service |
+| `get(params)` | Get service by ID |
+| `update(params)` | Update a service |
+| `delete(params)` | Delete a service |
+
+#### Agent API (`client.app.multiService.agent`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List agents |
+| `create(params)` | Create an agent |
+| `get(params)` | Get agent by ID |
+| `update(params)` | Update an agent |
+| `delete(params)` | Delete an agent |
+
+#### Appointment API (`client.app.multiService.appointment`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List appointments |
+| `create(params)` | Create an appointment |
+| `get(params)` | Get appointment by ID |
+| `updateStatus(params)` | Update appointment status |
+| `assignAgent(params)` | Assign an agent to appointment |
+
+#### Field Template API (`client.app.multiService.fieldTemplate`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List field templates |
+| `create(params)` | Create a field template |
+| `update(params)` | Update a field template |
+| `delete(params)` | Delete a field template |
 
-Checks if a user exists; if not, creates a new one.
+---
 
-```ts
-const user = await client.app.customer.auth({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  fullname: "John Doe",
-  telephone: "+2250700000000",
-  email: "john@example.com", // Optional
-  plateform: "STORE", // Optional: "STORE", "MULTI_SERVICE", etc.
-});
-```
+### Duticotac Module (`client.duticotac`)
 
-#### Check Customer Existence
+#### Balance API (`client.duticotac.balance`)
 
-Verify if a phone number is already registered.
+| Method | Description |
+|--------|-------------|
+| `get(params)` | Get account balance |
 
-```ts
-const user = await client.app.customer.check({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  telephone: "+2250700000000",
-});
-```
+#### Offer API (`client.duticotac.offer`)
 
-#### List Customers
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List offers |
+| `create(params)` | Create an offer |
+| `get(params)` | Get offer by ID |
+| `update(params)` | Update an offer |
+| `delete(params)` | Delete an offer |
 
-Retrieve a list of customers with optional filtering.
+#### Payment API (`client.duticotac.payment`)
 
-```ts
-const customers = await client.app.customer.list({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  plateformType: ["STORE"], // Optional filter
-});
-```
+| Method | Description |
+|--------|-------------|
+| `initiate(params)` | Initiate a payment |
+| `verify(params)` | Verify a payment |
 
-#### Get & Update Customer
+#### Transaction API (`client.duticotac.transaction`)
 
-Retrieve details or update profile information.
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List transactions |
+| `get(params)` | Get transaction by ID |
 
-```ts
-// Get details
-const detail = await client.app.customer.get({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  id: "customer_id",
-});
+---
 
-// Update profile
-await client.app.customer.update({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  id: "customer_id",
-  fullname: "Jane Doe",
-  email: "jane@example.com",
-});
-```
+### Kolabo Module (`client.kolabo`)
+
+#### App API (`client.kolabo.app`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List Kolabo apps |
+| `getBySlug(slug, params)` | Get app by slug |
+| `get(slug, params)` | Get app details |
+| `configure(slug, params)` | Configure a Kolabo app |
+| `join(slug, params)` | Join a Kolabo app |
+
+#### Customer API (`client.kolabo.customer`)
+
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List customers |
+| `get(params)` | Get customer by ID |
 
-### Other App Resources
+#### Partner API (`client.kolabo.partner`)
 
-- **Stats**: `client.app.stats.create(...)`
-- **Finance**: `client.app.finance.balance(...)`
-- **Info**: `client.app.info.list(...)`
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List partners |
+| `create(params)` | Create a partner |
+| `get(params)` | Get partner by ID |
+| `update(params)` | Update a partner |
 
 ---
 
-## E-Commerce (`client.app.store`)
+### Super Admin Module (`client.superAdmin`)
 
-Full-featured e-commerce management.
+#### Auth API (`client.superAdmin.auth`)
 
-### Products
+| Method | Description |
+|--------|-------------|
+| `init(params)` | Initialize super admin |
+| `signin(params)` | Sign in as super admin |
+| `me(params)` | Get current admin info |
 
-Create and manage products.
+#### Apps API (`client.superAdmin.apps`)
 
-```ts
-// Create a product
-await client.app.store.product.create({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  name: "Premium T-Shirt",
-  price: 2500,
-  sellerId: "seller_123",
-  categoryId: "category_123",
-  variants: [], // Array of product variants
-});
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List all apps |
+| `get(params)` | Get app by ID |
+| `update(params)` | Update an app |
 
-// List products
-await client.app.store.product.list({
-  appId: "app_123",
-  apiKey: "your_api_key",
-});
-```
+#### Modules API (`client.superAdmin.modules`)
 
-### Orders
+| Method | Description |
+|--------|-------------|
+| `list(params)` | List all modules |
+| `update(params)` | Update module settings |
 
-Handle customer orders.
+#### Stats API (`client.superAdmin.stats`)
 
-```ts
-// Create an order
-await client.app.store.order.create({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  items: [
-    { productId: "prod_1", quantity: 2 }
-  ],
-  customerId: "cust_1",
-  totalAmount: 5000,
-  shippingAddress: { ... }
-});
+| Method | Description |
+|--------|-------------|
+| `get(params)` | Get platform statistics |
 
-// List orders
-await client.app.store.order.list({
-  appId: "app_123",
-  apiKey: "your_api_key",
-});
-```
+#### Finance API (`client.superAdmin.finance`)
+
+| Method | Description |
+|--------|-------------|
+| `balance(params)` | Get platform balance |
+| `listTransactions(params)` | List platform transactions |
 
-### Available Store Modules
+#### Notification API (`client.superAdmin.notification`)
 
-- `badge`
-- `category`
-- `collection`
-- `discount`
-- `option`
-- `seller`
-- `shipping`
-- `tag`
-- `tax`
+| Method | Description |
+|--------|-------------|
+| `send(params)` | Send a notification |
+| `broadcast(params)` | Broadcast to all users |
 
 ---
 
-## Multi-Service (`client.app.multiService`)
+### Maintenance Module (`client.maintenance`)
 
-Booking system for service-based applications.
+| Method | Description |
+|--------|-------------|
+| `cronNotification(params)` | Run notification cron job |
+| `cronBilling(params)` | Run billing cron job |
+| `cleanupTransactions(params)` | Cleanup old transactions |
 
-### Appointments
+---
 
-Manage bookings between customers and agents/companies.
+## Error Handling
 
-```ts
-// Create an appointment
-await client.app.multiService.appointment.create({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  serviceId: "srv_123",
-  customerId: "cust_123",
-  date: "2024-12-25T10:00:00Z",
-  status: "PENDING",
-});
+All API methods return a promise that resolves to a response object:
 
-// Update status
-await client.app.multiService.appointment.updateStatus({
-  appId: "app_123",
-  apiKey: "your_api_key",
-  id: "apt_123",
-  status: "CONFIRMED",
-});
+```ts
+try {
+  const response = await client.app.customer.auth({
+    appId: "app_123",
+    apiKey: "your_api_key",
+    fullname: "John Doe",
+    telephone: "+2250700000000",
+  });
+
+  if (response.success) {
+    console.log("User:", response.data);
+  }
+} catch (error) {
+  console.error("Request failed:", error);
+}
 ```
 
-### Available Service Modules
-
-- `company`: Manage service providers.
-- `service`: Define services offered.
-- `agent`: Manage individual staff members.
-
 ---
 
 ## TypeScript Support
 
-The SDK is written in TypeScript and ships with full type definitions. You can import types directly to type your application logic.
+The SDK is written in TypeScript and ships with full type definitions:
 
 ```ts
 import {
   Customer,
-  CreateProductParams,
+  CustomerListItem,
   CustomerAuthParams,
+  CreateProductParams,
+  OrderStatus,
+  PaymentStatus,
+  // ... and many more
 } from "@applite/js-sdk";
 ```
 
+---
+
 ## Scripts
 
-- `pnpm build`: Build the SDK (ESM/CJS).
-- `pnpm test`: Run type checks.
+```bash
+pnpm build   # Build the SDK (ESM/CJS)
+pnpm test    # Run type checks
+```