washday-sdk

🌀 Washday SDK

Official JavaScript/TypeScript SDK for the Washday API. Provides easy-to-use methods for integrating Washday's laundry management platform into your applications.

🚀 Quick Start

Installation

npm install washday-sdk

Basic Usage

import { WashdayClient } from 'washday-sdk';

// Initialize the client
const client = new WashdayClient('your-api-token');

// Example: Clock in an employee
await client.attendance.clockIn({
    storeId: 'store-id',
    notes: 'Starting shift'
});

// Example: Get orders
const orders = await client.orders.getList({
    storeId: 'store-id',
    status: 'pending'
});

// Example: Create a customer
const customer = await client.customers.create({
    name: 'John Doe',
    email: '[e-mail]',
    phone: '[phone]'
});

📚 Documentation

For complete documentation, examples, and API reference, visit:

📖 docs/README.md

The documentation includes:

• 🚀 Getting Started - Installation, authentication, setup
• 🔧 API Modules - Complete reference for all modules (attendance, orders, customers, etc.)
• 📋 Examples - Common use cases and patterns
• 🎯 TypeScript - Full type definitions and interfaces

Popular Modules

• Attendance - Employee time tracking
• Orders - Order management
• Customers - Customer data
• Stores - Store configuration

🏗️ Architecture

washday-sdk/
├── src/
│   ├── api/           # API endpoint modules
│   ├── interfaces/    # TypeScript interfaces
│   └── utils/         # Utility functions
├── docs/              # 📚 Complete documentation
│   ├── modules/       # Module-specific guides
│   └── examples/      # Code examples
└── dist/              # Compiled JavaScript

🔑 Authentication

// Using API token (recommended)
const client = new WashdayClient('your-api-token');

// The token will be automatically included in all requests

🛠️ Development

# Install dependencies
npm install

# Build the SDK
npm run build

# Run tests
npm test

📋 Available Modules

Module	Description	Documentation
attendance	Employee time tracking	📖 Guide
orders	Order management	📖 Guide
customers	Customer data	📖 Guide
products	Product catalog	📖 Guide
stores	Store settings	📖 Guide
staff	Staff management	📖 Guide
inventory	Stock management	📖 Guide
reports	Analytics & reports	📖 Guide
cashups	Cash register	📖 Guide

See all modules →

🆕 What's New

• v1.1.1: 🐛 Fixed missing parameters in attendance endpoints (userId in getHistory/getStatus, storeId in clockOut)
• v1.1.0: ✨ Added Attendance module with clock-in/out functionality
• v1.0.2: 🔧 Enhanced order management features

🤝 Support

• 📖 Documentation: docs/README.md
• 🐛 Issues: Create an issue in the repository
• 💬 Questions: Contact the development team

📄 License

ISC License - see LICENSE file for details.