@withaevum/sdk 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,593 @@
+/**
+ * Configuration options for AevumClient
+ */
+export interface AevumClientConfig {
+    /** API key for authentication */
+    apiKey: string;
+    /** Base URL for the API (default: https://api.withaevum.com) */
+    baseUrl?: string;
+    /** Organization ID (optional, will be resolved from API key if not provided) */
+    orgId?: string;
+}
+/**
+ * Customer information
+ */
+export interface Customer {
+    id: string | null;
+    name: string | null;
+    email: string | null;
+    phone?: string | null;
+}
+/**
+ * Provider information
+ */
+export interface Provider {
+    id: string;
+    name: string | null;
+}
+/**
+ * Offering information
+ */
+export interface Offering {
+    id: string;
+    name: string | null;
+    price_cents?: number | null;
+}
+/**
+ * Booking object
+ */
+export interface Booking {
+    id: string;
+    kind: string | null;
+    status: string | null;
+    start_time: string | null;
+    end_time: string | null;
+    notes: string | null;
+    price_cents: number | null;
+    signed_up_at: string | null;
+    customer: Customer;
+    providers: Provider[];
+    offerings: Offering[];
+}
+/**
+ * Parameters for creating a booking
+ */
+export interface CreateBookingParams {
+    /** Provider ID (will be converted to providerIds array) */
+    providerId?: string;
+    /** Offering ID (will be converted to offeringIds array) */
+    offeringId?: string;
+    /** Provider IDs array */
+    providerIds?: string[];
+    /** Offering IDs array */
+    offeringIds?: string[];
+    /** Start time in ISO 8601 format with timezone */
+    startTime: string;
+    /** End time in ISO 8601 format with timezone (optional if duration can be inferred) */
+    endTime?: string;
+    /** Customer email (will create customer if doesn't exist) */
+    customerEmail?: string;
+    /** Customer ID (if customer already exists) */
+    customerId?: string;
+    /** Customer object for inline creation */
+    customer?: {
+        name?: string;
+        email?: string;
+        phone?: string;
+    };
+    /** Price in cents */
+    price_cents?: number;
+    /** Notes for the booking */
+    notes?: string;
+    /** Booking status (default: 'pending') */
+    status?: string;
+    /** Booking kind (default: 'standard') */
+    kind?: string;
+}
+/**
+ * Parameters for listing bookings
+ */
+export interface ListBookingsParams {
+    /** Filter by booking status */
+    status?: string;
+    /** Filter by provider ID */
+    providerId?: string;
+    /** Filter by customer ID */
+    customerId?: string;
+    /** Start date for filtering (ISO 8601 with timezone) */
+    startDate?: string;
+    /** End date for filtering (ISO 8601 with timezone) */
+    endDate?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 20, max: 100) */
+    pageSize?: number;
+}
+/**
+ * Paginated response for bookings list
+ */
+export interface ListBookingsResponse {
+    page: number;
+    pageSize: number;
+    total: number;
+    totalPages: number;
+    bookings: Booking[];
+}
+/**
+ * Availability slot
+ */
+export interface AvailabilitySlot {
+    tz: string;
+    start_time_utc: string;
+    end_time_utc: string;
+    local_label: string;
+    scheduleId?: string;
+}
+/**
+ * Parameters for getting availability slots
+ */
+export interface GetSlotsParams {
+    /** Provider ID */
+    providerId: string;
+    /** Start date (ISO 8601 with timezone, e.g., '2024-01-15T00:00:00Z') */
+    startDate: string;
+    /** End date (ISO 8601 with timezone, e.g., '2024-01-22T23:59:59Z') */
+    endDate: string;
+}
+/**
+ * Response for getting availability slots
+ */
+export interface GetSlotsResponse {
+    slots: AvailabilitySlot[];
+}
+/**
+ * Parameters for checking availability
+ */
+export interface CheckAvailabilityParams {
+    /** Provider ID */
+    providerId: string;
+    /** Start time to check (ISO 8601 with timezone) */
+    startTime: string;
+    /** Duration in minutes */
+    duration: number;
+}
+/**
+ * Response for checking availability
+ */
+export interface CheckAvailabilityResponse {
+    available: boolean;
+}
+/**
+ * Parameters for canceling a booking
+ */
+export interface CancelBookingParams {
+    /** Optional cancellation reason */
+    reason?: string;
+    /** Whether to send notification (default: false) */
+    sendNotification?: boolean;
+}
+/**
+ * Parameters for rescheduling a booking
+ */
+export interface RescheduleBookingParams {
+    /** New start time in ISO 8601 format with timezone */
+    start_time: string;
+    /** New end time in ISO 8601 format with timezone */
+    end_time: string;
+    /** Whether to send notification (default: false) */
+    sendNotification?: boolean;
+}
+/**
+ * Complete offering information
+ */
+export interface Offering {
+    id: string;
+    name: string | null;
+    description?: string | null;
+    price_cents?: number | null;
+    duration_minutes?: number | null;
+    timezone?: string | null;
+    is_all_day?: boolean;
+    attendee_mode?: '1:1' | 'group' | null;
+    attendee_limit?: number | null;
+    customer?: string | null;
+    status?: string | null;
+    type?: string | null;
+    time_mode?: string | null;
+    start_time?: string | null;
+    end_time?: string | null;
+    session_count?: number | null;
+    recurrence_preset?: string | null;
+    recurrence_interval_count?: number | null;
+    recurrence_interval_unit?: string | null;
+    recurrence_repeat_on?: string | null;
+    recurrence_end_mode?: string | null;
+    recurrence_end_date?: string | null;
+    recurrence_end_count?: number | null;
+    override_price_cents?: number | null;
+    min_age?: number | null;
+    max_age?: number | null;
+    window_start_time?: string | null;
+    window_end_time?: string | null;
+    cadence_minutes?: number | null;
+    slot_days?: string | null;
+    hours?: any;
+    weekly_hours?: any;
+    monthly_recurrence?: any;
+    providers?: Array<{
+        id: string;
+        name: string | null;
+    }>;
+}
+/**
+ * Parameters for creating an offering
+ */
+export interface CreateOfferingParams {
+    name: string;
+    description?: string;
+    price_cents?: number | null;
+    duration_minutes?: number | null;
+    timezone?: string;
+    is_all_day?: boolean;
+    attendee_mode?: '1:1' | 'group';
+    attendee_limit?: number | null;
+    customer?: string;
+    status?: string;
+    type?: string;
+    time_mode?: string;
+    start_time?: string;
+    end_time?: string;
+    session_count?: number | null;
+    recurrence_preset?: string | null;
+    recurrence_interval_count?: number;
+    recurrence_interval_unit?: string;
+    recurrence_repeat_on?: string | null;
+    recurrence_end_mode?: string | null;
+    recurrence_end_date?: string;
+    recurrence_end_count?: number | null;
+    override_price_cents?: number | null;
+    min_age?: number | null;
+    max_age?: number | null;
+    window_start_time?: string;
+    window_end_time?: string;
+    cadence_minutes?: number | null;
+    slot_days?: string;
+    providerIds?: string[];
+    hours?: any;
+    weekly_hours?: any;
+    monthly_recurrence?: any;
+}
+/**
+ * Parameters for listing offerings
+ */
+export interface ListOfferingsParams {
+    /** Filter by event ID */
+    eventId?: string;
+    /** Filter by provider ID */
+    providerId?: string;
+}
+/**
+ * Parameters for creating a simple offering (basic 1:1 offering using provider availability)
+ */
+export interface CreateSimpleOfferingParams {
+    /** Offering name (required) */
+    name: string;
+    /** Duration in minutes (required) */
+    duration_minutes: number;
+    /** Price in cents (optional) */
+    price_cents?: number | null;
+    /** Description (optional) */
+    description?: string;
+    /** Timezone (optional, defaults to organization timezone) */
+    timezone?: string;
+    /** Provider IDs to associate with this offering (optional) */
+    providerIds?: string[];
+}
+/**
+ * Time slot for recurring offerings
+ */
+export interface TimeSlot {
+    /** Start time in HH:MM format (e.g., '09:00') */
+    start: string;
+    /** End time in HH:MM format (e.g., '17:00') */
+    end: string;
+}
+/**
+ * Parameters for creating a weekly recurring offering
+ */
+export interface CreateRecurringWeeklyOfferingParams {
+    /** Offering name (required) */
+    name: string;
+    /** Duration in minutes (required) */
+    duration_minutes: number;
+    /** Days of the week (required, e.g., ['monday', 'wednesday', 'friday'] or ['MO', 'WE', 'FR']) */
+    days: string[];
+    /** Time slots for each day (required) */
+    timeSlots: TimeSlot[];
+    /** Price in cents (optional) */
+    price_cents?: number | null;
+    /** Description (optional) */
+    description?: string;
+    /** Timezone (optional, defaults to organization timezone) */
+    timezone?: string;
+    /** Provider IDs to associate with this offering (optional) */
+    providerIds?: string[];
+}
+/**
+ * Parameters for creating a daily recurring offering
+ */
+export interface CreateRecurringDailyOfferingParams {
+    /** Offering name (required) */
+    name: string;
+    /** Duration in minutes (required) */
+    duration_minutes: number;
+    /** Time slots for each day (required) */
+    timeSlots: TimeSlot[];
+    /** Price in cents (optional) */
+    price_cents?: number | null;
+    /** Description (optional) */
+    description?: string;
+    /** Timezone (optional, defaults to organization timezone) */
+    timezone?: string;
+    /** Provider IDs to associate with this offering (optional) */
+    providerIds?: string[];
+}
+/**
+ * Parameters for creating an offering via the simplified endpoint
+ */
+export interface CreateSimpleOfferingEndpointParams {
+    /** Offering name (required) */
+    name: string;
+    /** Duration in minutes (required) */
+    duration_minutes: number;
+    /** Description (optional) */
+    description?: string;
+    /** Price in cents (optional) */
+    price_cents?: number | null;
+    /** Timezone (optional, defaults to organization timezone) */
+    timezone?: string;
+    /** Provider IDs to associate with this offering (optional) */
+    provider_ids?: string[];
+    /** Preset type (optional, defaults to 'simple_1on1') */
+    preset?: 'simple_1on1' | 'simple_group' | 'recurring_weekly' | 'recurring_daily';
+    /** Days of the week for weekly recurring (required if preset is 'recurring_weekly') */
+    weekly_days?: string[];
+    /** Time slots for weekly recurring (required if preset is 'recurring_weekly') */
+    weekly_time_slots?: TimeSlot[];
+    /** Time slots for daily recurring (required if preset is 'recurring_daily') */
+    daily_time_slots?: TimeSlot[];
+    /** Attendee limit for group offerings (required if preset is 'simple_group') */
+    attendee_limit?: number;
+}
+/**
+ * Complete customer information
+ */
+export interface Customer {
+    id: string | null;
+    name: string | null;
+    email: string | null;
+    phone?: string | null;
+    user?: {
+        id: string | null;
+    } | null;
+}
+/**
+ * Parameters for creating a customer
+ */
+export interface CreateCustomerParams {
+    name?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    userId?: string | null;
+}
+/**
+ * Parameters for listing customers
+ */
+export interface ListCustomersParams {
+    /** Search term (name/email/phone) */
+    q?: string;
+    /** Filter by provider ID */
+    providerId?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 50, max: 100) */
+    pageSize?: number;
+}
+/**
+ * Paginated response for customers list
+ */
+export interface ListCustomersResponse {
+    page: number;
+    pageSize: number;
+    total: number;
+    totalPages: number;
+    customers: Customer[];
+}
+/**
+ * Customer booking history response
+ */
+export interface CustomerHistoryResponse {
+    customer: {
+        id: string;
+        name: string | null;
+        email: string | null;
+    };
+    analytics: {
+        totalBookings: number;
+        confirmedBookings: number;
+        cancelledBookings: number;
+        totalRevenue: number;
+        averageBookingValue: number;
+    };
+    mostRecentBooking: {
+        id: string;
+        status: string | null;
+        start_time: string | null;
+        price_cents: number | null;
+    } | null;
+    favoriteProviders: Array<{
+        providerId: string;
+        name: string | null;
+        count: number;
+    }>;
+}
+/**
+ * Complete provider information
+ */
+export interface Provider {
+    id: string;
+    name: string | null;
+    email?: string | null;
+    phone?: string | null;
+    created_at?: string | null;
+    user_id?: string | null;
+    bio?: string | null;
+}
+/**
+ * Parameters for creating a provider
+ */
+export interface CreateProviderParams {
+    name: string;
+    email?: string;
+    phone?: string;
+    userId?: string | null;
+    bio?: string;
+    externalId?: string;
+}
+/**
+ * Parameters for listing providers
+ */
+export interface ListProvidersParams {
+    /** Search term */
+    query?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 20, max: 100) */
+    pageSize?: number;
+}
+/**
+ * Calendar event
+ */
+export interface CalendarEvent {
+    id: string;
+    title: string;
+    status: string | null;
+    notes?: string | null;
+    start_time: string | null;
+    end_time: string | null;
+    offering?: {
+        id: string;
+        name: string | null;
+    } | null;
+    attendee_mode?: '1:1' | 'group' | null;
+    attendee_limit?: number | null;
+}
+/**
+ * Parameters for getting calendar events
+ */
+export interface GetCalendarEventsParams {
+    /** Filter by provider ID */
+    providerId?: string;
+    /** Start date (ISO 8601 with timezone) */
+    start?: string;
+    /** End date (ISO 8601 with timezone) */
+    end?: string;
+}
+/**
+ * Response for getting calendar events
+ */
+export interface GetCalendarEventsResponse {
+    bookings: Booking[];
+    events: CalendarEvent[];
+}
+/**
+ * Parameters for getting revenue analytics
+ */
+export interface GetRevenueParams {
+    /** Filter by provider ID */
+    providerId?: string;
+    /** Start date (ISO 8601 datetime) */
+    startDate?: string;
+    /** End date (ISO 8601 datetime) */
+    endDate?: string;
+    /** Group by period or entity */
+    groupBy?: 'day' | 'week' | 'month' | 'offering' | 'provider';
+}
+/**
+ * Revenue analytics response
+ */
+export interface RevenueResponse {
+    period: {
+        startDate: string | null;
+        endDate: string | null;
+        groupBy: string;
+    };
+    breakdown: Array<{
+        period: string;
+        revenue: number;
+    } | {
+        id: string;
+        name: string | null;
+        revenue: number;
+        count: number;
+    }>;
+    totalRevenue: number;
+}
+/**
+ * Parameters for getting payouts
+ */
+export interface GetPayoutsParams {
+    /** Filter by provider ID */
+    providerId?: string;
+    /** Start date (ISO 8601 datetime) */
+    startDate?: string;
+    /** End date (ISO 8601 datetime) */
+    endDate?: string;
+    /** Filter by customer ID */
+    customerId?: string;
+}
+/**
+ * Payouts response
+ */
+export interface PayoutsResponse {
+    payouts: Array<{
+        bookingId: string;
+        customerId: string | null;
+        amount: number;
+        date: string;
+        offeringId: string | null;
+    }>;
+    total: number;
+}
+/**
+ * Availability schedule
+ */
+export interface AvailabilitySchedule {
+    id: string;
+    providerId: string;
+    name?: string | null;
+    timezone?: string | null;
+    [key: string]: any;
+}
+/**
+ * Parameters for getting availability schedules
+ */
+export interface GetAvailabilitySchedulesParams {
+    /** Filter by provider ID */
+    providerId?: string;
+}
+/**
+ * Enhanced parameters for getting availability slots
+ */
+export interface GetAvailabilitySlotsParams {
+    /** Provider ID */
+    providerId?: string;
+    /** Offering ID */
+    offeringId?: string;
+    /** Start date (ISO 8601 with timezone) */
+    start?: string;
+    /** End date (ISO 8601 with timezone) */
+    end?: string;
+    /** Maximum number of slots to return */
+    limit?: number;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+// packages/sdk/src/types.ts
+export {};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@withaevum/sdk",
+  "version": "1.0.0",
+  "description": "TypeScript SDK for the Aevum API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "echo \"No linting configured\""
+  },
+  "keywords": [
+    "aevum",
+    "scheduling",
+    "bookings",
+    "api",
+    "sdk",
+    "typescript",
+    "calendar",
+    "appointments"
+  ],
+  "author": "",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getaevum/aevum.git",
+    "directory": "packages/sdk"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  }
+}