@dispatch9/client-sdk/examples/complete-workflow.js

Official Node.js SDK for Dispatch9 API - Complete solution with email/phone client creation, order management, client management, and dual-method authentication

require('dotenv').config();
const Dispatch9Client = require('../src/client');

/**
 * Complete Workflow Example
 * Demonstrates end-to-end usage of all 4 core operations:
 * 1. Create Client → 2. Get Clients → 3. Create Order → 4. Update Order
 * 
 * This example shows a realistic business scenario where:
 * - A new restaurant partner joins the platform
 * - They start receiving and processing orders
 * - Orders are tracked and updated through their lifecycle
 */
async function completeWorkflowExample() {
  console.log('🚀 Dispatch9 SDK - Complete Workflow Example\n');
  console.log('📖 Scenario: New restaurant partner onboarding and first orders\n');

  try {
    // Initialize the SDK
    const dispatch9 = new Dispatch9Client({
      apiKey: process.env.DISPATCH9_API_KEY,
      baseURL: process.env.DISPATCH9_BASE_URL || 'https://api.dispatch9.com',
      debug: false // Keep output clean for workflow demo
    });

    console.log('✅ SDK initialized successfully\n');

    // ==========================================
    // PHASE 1: PARTNER ONBOARDING
    // ==========================================
    
    console.log('🏢 PHASE 1: Partner Onboarding');
    console.log('═'.repeat(50));
    
    console.log('📝 Creating new restaurant partner...');
    
    const newPartner = await dispatch9.createClient({
      name: 'Bella Vista Italian Kitchen',
      email: 'operations@bellavista.com',
      businessType: 'restaurant',
      websiteURL: 'https://www.bellavista.com',
      taxId: '12-9876543',
      webhookURL: 'https://www.bellavista.com/api/dispatch9-webhook',
      orderSettings: {
        autoAccept: false, // Manual review for new partner
        autoAssign: false,
        maxOrdersPerHour: 30,
        preparationTime: 35,
        deliveryRadius: 10.0
      },
      permissions: {
        createOrders: true,
        viewOrders: true,
        modify: false,
        delete: false
      },
      authentication: {
        enablePortalAccess: true,
        firstName: 'Giuseppe',
        lastName: 'Romano',
        businessName: 'Bella Vista Italian Kitchen',
        phone: '+1-555-BELLA-1'
      },
      apiConfig: {
        enabled: true,
        rateLimit: 300
      }
    });

    console.log(`✅ Partner onboarded successfully!`);
    console.log(`   Partner ID: ${newPartner.id}`);
    console.log(`   Name: ${newPartner.name}`);
    console.log(`   Contact: ${newPartner.authentication?.firstName} ${newPartner.authentication?.lastName}`);
    console.log(`   Preparation Time: ${newPartner.orderSettings?.preparationTime} minutes`);
    console.log(`   Delivery Radius: ${newPartner.orderSettings?.deliveryRadius} km\n`);

    // ==========================================
    // PHASE 2: PARTNER VERIFICATION
    // ==========================================
    
    console.log('🔍 PHASE 2: Partner Verification');
    console.log('═'.repeat(50));
    
    console.log('📋 Retrieving all restaurant partners for verification...');
    
    const restaurants = await dispatch9.getClients({
      businessType: 'restaurant',
      status: 'active',
      limit: 10,
      sortBy: 'createdAt:desc'
    });

    console.log(`✅ Found ${restaurants.totalResults} total restaurant partners`);
    console.log(`   Showing ${restaurants.results.length} most recent:`);
    
    restaurants.results.forEach((partner, index) => {
      const isNew = partner.id === newPartner.id;
      const marker = isNew ? '🆕' : '  ';
      console.log(`   ${marker} ${index + 1}. ${partner.name} (${partner.email})`);
      if (isNew) {
        console.log(`      ↳ This is our new partner!`);
      }
    });
    console.log();

    // ==========================================
    // PHASE 3: FIRST ORDER PROCESSING
    // ==========================================
    
    console.log('🍝 PHASE 3: First Order Processing');
    console.log('═'.repeat(50));
    
    console.log('📦 Creating first order from new partner...');
    
    const firstOrder = await dispatch9.createOrder({
      orderTotal: 78.95,
      client: newPartner.id,
      orderCurrency: 'USD',
      hasGoods: true,
      priority: 5,
      items: [
        {
          SKU: 'PASTA001',
          itemName: 'Spaghetti Carbonara',
          price: 24.95,
          quantity: 2,
          category: 'Main Course',
          description: 'Classic Roman pasta with eggs, cheese, and pancetta',
          weight: 0.6,
          weightUnit: 'kg',
          notes: 'Extra cheese on the side'
        },
        {
          SKU: 'APP001',
          itemName: 'Bruschetta al Pomodoro',
          price: 12.95,
          quantity: 1,
          category: 'Appetizer',
          description: 'Grilled bread with fresh tomatoes and basil',
          weight: 0.3,
          weightUnit: 'kg'
        },
        {
          SKU: 'DESS001',
          itemName: 'Tiramisu',
          price: 8.95,
          quantity: 2,
          category: 'Dessert',
          description: 'Classic Italian coffee-flavored dessert',
          weight: 0.4,
          weightUnit: 'kg',
          handling: 'Keep refrigerated'
        }
      ],
      specialInstructions: 'First order for new partner - handle with extra care',
      customerNotes: 'Customer requested contactless delivery',
      requiredProof: {
        signature: false,
        photo: true
      },
      metadata: {
        isFirstOrder: true,
        partnerOnboardingDate: new Date().toISOString(),
        customerType: 'regular'
      }
    });

    console.log(`✅ First order created successfully!`);
    console.log(`   Order ID: ${firstOrder.id}`);
    console.log(`   Total: $${firstOrder.orderTotal}`);
    console.log(`   Items: ${firstOrder.items.length} items`);
    console.log(`   Status: ${firstOrder.status}`);
    console.log(`   Priority: ${firstOrder.priority}`);
    
    // Show order items
    console.log('   📋 Order Items:');
    firstOrder.items.forEach((item, index) => {
      console.log(`      ${index + 1}. ${item.itemName} x${item.quantity} - $${item.price}`);
    });
    console.log();

    // ==========================================
    // PHASE 4: ORDER LIFECYCLE MANAGEMENT
    // ==========================================
    
    console.log('🔄 PHASE 4: Order Lifecycle Management');
    console.log('═'.repeat(50));
    
    // Step 1: Confirm the order
    console.log('✅ Step 1: Restaurant confirms the order...');
    
    const confirmedOrder = await dispatch9.updateOrder(firstOrder.id, {
      status: 'confirmed',
      statusNotes: 'Order confirmed by kitchen staff',
      priority: 6, // Slightly increased priority
      metadata: {
        ...firstOrder.metadata,
        confirmedBy: 'Giuseppe Romano',
        confirmedAt: new Date().toISOString(),
        estimatedPrepTime: 35
      }
    });

    console.log(`   ✅ Order confirmed - Status: ${confirmedOrder.status}`);
    console.log(`   📝 Notes: ${confirmedOrder.statusNotes}`);
    console.log(`   🎯 Priority: ${confirmedOrder.priority}\n`);

    // Step 2: Order preparation begins
    console.log('👨‍🍳 Step 2: Kitchen begins preparation...');
    
    const inProgressOrder = await dispatch9.updateOrder(firstOrder.id, {
      status: 'in_progress',
      statusNotes: 'Kitchen has started preparing the order',
      specialInstructions: 'First order for new partner - handle with extra care. Customer requested contactless delivery.',
      metadata: {
        ...confirmedOrder.metadata,
        prepStartedAt: new Date().toISOString(),
        kitchenStation: 'Station 3',
        chefAssigned: 'Marco Antonelli'
      }
    });

    console.log(`   ✅ Preparation started - Status: ${inProgressOrder.status}`);
    console.log(`   👨‍🍳 Chef: ${inProgressOrder.metadata?.chefAssigned}`);
    console.log(`   🏪 Station: ${inProgressOrder.metadata?.kitchenStation}\n`);

    // Step 3: Add special request
    console.log('📞 Step 3: Customer calls with special request...');
    
    const updatedOrder = await dispatch9.updateOrder(firstOrder.id, {
      customerNotes: 'Customer requested contactless delivery. UPDATED: Please include extra napkins and utensils.',
      statusNotes: 'Customer called with additional request for extra napkins',
      items: [
        ...inProgressOrder.items.map(item => 
          item.SKU === 'PASTA001' 
            ? { ...item, notes: 'Extra cheese on the side + extra napkins requested' }
            : item
        )
      ],
      metadata: {
        ...inProgressOrder.metadata,
        customerCallTime: new Date().toISOString(),
        specialRequest: 'Extra napkins and utensils'
      }
    });

    console.log(`   ✅ Special request added`);
    console.log(`   📝 Updated notes: ${updatedOrder.customerNotes}`);
    console.log(`   🍝 Updated pasta notes: ${updatedOrder.items.find(i => i.SKU === 'PASTA001')?.notes}\n`);

    // ==========================================
    // PHASE 5: PARTNER SUCCESS METRICS
    // ==========================================
    
    console.log('📊 PHASE 5: Partner Success Metrics');
    console.log('═'.repeat(50));
    
    // Update partner settings based on successful first order
    console.log('🎯 Updating partner settings based on successful first order...');
    
    const optimizedPartner = await dispatch9.updateClient(newPartner.id, {
      orderSettings: {
        autoAccept: true, // Enable auto-accept after successful first order
        autoAssign: false, // Keep manual assignment for now
        maxOrdersPerHour: 35, // Slightly increased capacity
        preparationTime: 30, // Reduced based on actual performance
        deliveryRadius: 12.0 // Expanded radius
      },
      apiConfig: {
        enabled: true,
        rateLimit: 500 // Increased rate limit
      },
      status: 'active'
    });

    console.log(`   ✅ Partner settings optimized!`);
    console.log(`   🚀 Auto Accept: ${optimizedPartner.orderSettings?.autoAccept}`);
    console.log(`   ⏱️  Prep Time: ${optimizedPartner.orderSettings?.preparationTime} minutes`);
    console.log(`   📍 Delivery Radius: ${optimizedPartner.orderSettings?.deliveryRadius} km`);
    console.log(`   🔥 Rate Limit: ${optimizedPartner.apiConfig?.rateLimit} req/hour\n`);

    // ==========================================
    // WORKFLOW SUMMARY
    // ==========================================
    
    console.log('🎉 WORKFLOW COMPLETED SUCCESSFULLY!');
    console.log('═'.repeat(50));
    console.log('📈 Complete Business Flow Summary:');
    console.log();
    console.log('🏢 PARTNER ONBOARDING:');
    console.log(`   ✓ Created: ${newPartner.name}`);
    console.log(`   ✓ Contact: ${newPartner.authentication?.firstName} ${newPartner.authentication?.lastName}`);
    console.log(`   ✓ Business Type: ${newPartner.businessType}`);
    console.log();
    console.log('🔍 VERIFICATION:');
    console.log(`   ✓ Retrieved ${restaurants.totalResults} restaurant partners`);
    console.log(`   ✓ Verified new partner in system`);
    console.log();
    console.log('📦 ORDER PROCESSING:');
    console.log(`   ✓ Created first order: $${firstOrder.orderTotal}`);
    console.log(`   ✓ Order items: ${firstOrder.items.length} items`);
    console.log(`   ✓ Initial status: ${firstOrder.status}`);
    console.log();
    console.log('🔄 LIFECYCLE MANAGEMENT:');
    console.log(`   ✓ Confirmed → In Progress → Updated`);
    console.log(`   ✓ Final status: ${updatedOrder.status}`);
    console.log(`   ✓ Priority: ${updatedOrder.priority}`);
    console.log(`   ✓ Special requests handled`);
    console.log();
    console.log('⚡ OPTIMIZATION:');
    console.log(`   ✓ Auto Accept: ${optimizedPartner.orderSettings?.autoAccept}`);
    console.log(`   ✓ Reduced prep time: ${optimizedPartner.orderSettings?.preparationTime} min`);
    console.log(`   ✓ Expanded radius: ${optimizedPartner.orderSettings?.deliveryRadius} km`);
    console.log();
    console.log('🚀 Ready for production operations!');

  } catch (error) {
    console.error('❌ Error in complete workflow:', error.message);
    
    // Provide helpful troubleshooting information
    if (error.message.includes('Authentication failed')) {
      console.error('\n🔧 Troubleshooting:');
      console.error('   • Check your DISPATCH9_API_KEY in the .env file');
      console.error('   • Ensure the API key is valid and not expired');
    } else if (error.message.includes('Access forbidden')) {
      console.error('\n🔧 Troubleshooting:');
      console.error('   • Your API key may not have the required permissions');
      console.error('   • Required permissions: orders.create, orders.update, clients.create, clients.read, clients.update');
    } else if (error.message.includes('Rate limit exceeded')) {
      console.error('\n🔧 Troubleshooting:');
      console.error('   • You are making requests too quickly');
      console.error('   • Wait a moment and try again');
    }
    
    process.exit(1);
  }
}

// Run the example
if (require.main === module) {
  completeWorkflowExample();
}

module.exports = completeWorkflowExample;