@workbenchcrm/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,1533 @@
+/**
+ * @file types/index.ts
+ * @description TypeScript type definitions for the Workbench SDK
+ *
+ * These types mirror the API response structures and provide
+ * full type safety when working with the Workbench API.
+ */
+/**
+ * Configuration options for the Workbench client
+ */
+interface WorkbenchConfig {
+    /** API key for authentication (wbk_live_xxx or wbk_test_xxx) */
+    apiKey?: string;
+    /** OAuth access token for third-party app authentication */
+    accessToken?: string;
+    /** Base URL for the API (defaults to https://api.tryworkbench.app) */
+    baseUrl?: string;
+    /** Request timeout in milliseconds (defaults to 30000) */
+    timeout?: number;
+    /** Maximum number of retries for failed requests (defaults to 3) */
+    maxRetries?: number;
+}
+/**
+ * Options for paginated list requests
+ */
+interface ListOptions {
+    /** Page number (1-indexed, defaults to 1) */
+    page?: number;
+    /** Items per page (1-100, defaults to 20) */
+    per_page?: number;
+    /** Search query string */
+    search?: string;
+    /** Field to sort by */
+    sort?: string;
+    /** Sort order */
+    order?: 'asc' | 'desc';
+}
+/**
+ * Standard API response metadata
+ */
+interface ResponseMeta {
+    /** Unique request identifier for debugging */
+    request_id: string;
+    /** Server timestamp of the response */
+    timestamp: string;
+}
+/**
+ * Pagination information for list responses
+ */
+interface Pagination {
+    /** Current page number */
+    page: number;
+    /** Items per page */
+    per_page: number;
+    /** Total number of items */
+    total: number;
+    /** Total number of pages */
+    total_pages: number;
+    /** Whether there's a next page */
+    has_more: boolean;
+}
+/**
+ * Standard API response wrapper for single items
+ */
+interface ApiResponse<T> {
+    data: T;
+    meta: ResponseMeta;
+}
+/**
+ * Standard API response wrapper for lists
+ */
+interface ListResponse<T> {
+    data: T[];
+    meta: ResponseMeta;
+    pagination: Pagination;
+}
+/**
+ * API error response
+ */
+interface ApiError {
+    error: {
+        code: string;
+        message: string;
+        details?: Array<{
+            field: string;
+            message: string;
+        }>;
+    };
+    meta: ResponseMeta;
+}
+/**
+ * Client status values
+ */
+type ClientStatus = 'active' | 'inactive' | 'lead' | 'prospect';
+/**
+ * Client record
+ */
+interface Client {
+    id: string;
+    business_id: string;
+    first_name: string;
+    last_name: string | null;
+    company: string | null;
+    email: string | null;
+    phone: string | null;
+    status: ClientStatus;
+    source: string | null;
+    notes: string | null;
+    tags: string[] | null;
+    next_contact_date: string | null;
+    ask_for_review: boolean | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Options for creating a client
+ */
+interface CreateClientOptions {
+    first_name: string;
+    last_name?: string | null;
+    company?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    status?: ClientStatus;
+    source?: string | null;
+    notes?: string | null;
+    tags?: string[] | null;
+}
+/**
+ * Options for updating a client
+ */
+interface UpdateClientOptions extends Partial<CreateClientOptions> {
+    next_contact_date?: string | null;
+    ask_for_review?: boolean | null;
+}
+/**
+ * Options for listing clients
+ */
+interface ListClientsOptions extends ListOptions {
+    status?: ClientStatus;
+}
+/**
+ * Invoice status values
+ */
+type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'overdue' | 'cancelled';
+/**
+ * Invoice line item
+ */
+interface InvoiceItem {
+    id?: string;
+    description: string;
+    quantity: number;
+    unit_price: number;
+    sort_order?: number;
+}
+/**
+ * Invoice record
+ */
+interface Invoice {
+    id: string;
+    business_id: string;
+    client_id: string | null;
+    job_id: string | null;
+    invoice_number: string;
+    status: InvoiceStatus;
+    issue_date: string;
+    due_date: string | null;
+    subtotal: number;
+    tax_rate: number | null;
+    tax_amount: number | null;
+    discount_amount: number | null;
+    total: number;
+    amount_paid: number;
+    notes: string | null;
+    terms: string | null;
+    items: InvoiceItem[];
+    client?: Client;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Options for creating an invoice
+ */
+interface CreateInvoiceOptions {
+    client_id?: string | null;
+    job_id?: string | null;
+    status?: InvoiceStatus;
+    issue_date?: string;
+    due_date?: string | null;
+    tax_rate?: number | null;
+    discount_amount?: number | null;
+    notes?: string | null;
+    terms?: string | null;
+    items: InvoiceItem[];
+}
+/**
+ * Options for updating an invoice
+ */
+interface UpdateInvoiceOptions extends Partial<Omit<CreateInvoiceOptions, 'items'>> {
+    items?: InvoiceItem[];
+}
+/**
+ * Options for listing invoices
+ */
+interface ListInvoicesOptions extends ListOptions {
+    status?: InvoiceStatus;
+    client_id?: string;
+}
+/**
+ * Quote status values
+ */
+type QuoteStatus = 'draft' | 'sent' | 'viewed' | 'approved' | 'rejected' | 'expired' | 'converted';
+/**
+ * Quote line item
+ */
+interface QuoteItem {
+    id?: string;
+    description: string;
+    quantity: number;
+    unit_price: number;
+    sort_order?: number;
+}
+/**
+ * Quote record
+ */
+interface Quote {
+    id: string;
+    business_id: string;
+    client_id: string | null;
+    job_id: string | null;
+    quote_number: string;
+    status: QuoteStatus;
+    issue_date: string;
+    valid_until: string | null;
+    subtotal: number;
+    tax_rate: number | null;
+    tax_amount: number | null;
+    discount_amount: number | null;
+    total: number;
+    notes: string | null;
+    terms: string | null;
+    items: QuoteItem[];
+    client?: Client;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Options for creating a quote
+ */
+interface CreateQuoteOptions {
+    client_id?: string | null;
+    job_id?: string | null;
+    status?: QuoteStatus;
+    issue_date?: string;
+    valid_until?: string | null;
+    tax_rate?: number | null;
+    discount_amount?: number | null;
+    notes?: string | null;
+    terms?: string | null;
+    items: QuoteItem[];
+}
+/**
+ * Options for updating a quote
+ */
+interface UpdateQuoteOptions extends Partial<Omit<CreateQuoteOptions, 'items'>> {
+    items?: QuoteItem[];
+}
+/**
+ * Options for listing quotes
+ */
+interface ListQuotesOptions extends ListOptions {
+    status?: QuoteStatus;
+    client_id?: string;
+}
+/**
+ * Job status values
+ */
+type JobStatus = 'pending' | 'scheduled' | 'in_progress' | 'completed' | 'cancelled' | 'on_hold';
+/**
+ * Job priority values
+ */
+type JobPriority = 'low' | 'medium' | 'high' | 'urgent';
+/**
+ * Job record
+ */
+interface Job {
+    id: string;
+    business_id: string;
+    client_id: string | null;
+    title: string;
+    description: string | null;
+    status: JobStatus;
+    priority: JobPriority;
+    scheduled_start: string | null;
+    scheduled_end: string | null;
+    actual_start: string | null;
+    actual_end: string | null;
+    estimated_duration: number | null;
+    address_id: string | null;
+    notes: string | null;
+    client?: Client;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Options for creating a job
+ */
+interface CreateJobOptions {
+    client_id?: string | null;
+    title: string;
+    description?: string | null;
+    status?: JobStatus;
+    priority?: JobPriority;
+    scheduled_start?: string | null;
+    scheduled_end?: string | null;
+    estimated_duration?: number | null;
+    address_id?: string | null;
+    notes?: string | null;
+}
+/**
+ * Options for updating a job
+ */
+interface UpdateJobOptions extends Partial<CreateJobOptions> {
+    actual_start?: string | null;
+    actual_end?: string | null;
+}
+/**
+ * Options for listing jobs
+ */
+interface ListJobsOptions extends ListOptions {
+    status?: JobStatus;
+    priority?: JobPriority;
+    client_id?: string;
+}
+/**
+ * Service request status values
+ */
+type ServiceRequestStatus = 'new' | 'reviewing' | 'scheduled' | 'completed' | 'cancelled' | 'declined';
+/**
+ * Service request priority values
+ */
+type ServiceRequestPriority = 'low' | 'medium' | 'high' | 'urgent';
+/**
+ * Service request record
+ */
+interface ServiceRequest {
+    id: string;
+    business_id: string;
+    client_id: string | null;
+    title: string;
+    description: string | null;
+    status: ServiceRequestStatus;
+    source: string | null;
+    priority: ServiceRequestPriority | null;
+    requested_date: string | null;
+    preferred_time: string | null;
+    address: string | null;
+    contact_name: string | null;
+    contact_email: string | null;
+    contact_phone: string | null;
+    notes: string | null;
+    client?: Client;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Options for creating a service request
+ */
+interface CreateServiceRequestOptions {
+    client_id?: string | null;
+    title: string;
+    description?: string | null;
+    status?: ServiceRequestStatus;
+    source?: string | null;
+    priority?: ServiceRequestPriority | null;
+    requested_date?: string | null;
+    preferred_time?: string | null;
+    address?: string | null;
+    contact_name?: string | null;
+    contact_email?: string | null;
+    contact_phone?: string | null;
+    notes?: string | null;
+}
+/**
+ * Options for updating a service request
+ */
+type UpdateServiceRequestOptions = Partial<CreateServiceRequestOptions>;
+/**
+ * Options for listing service requests
+ */
+interface ListServiceRequestsOptions extends ListOptions {
+    status?: ServiceRequestStatus;
+    priority?: ServiceRequestPriority;
+    client_id?: string;
+}
+/**
+ * Available webhook event types
+ */
+type WebhookEvent = 'client.created' | 'client.updated' | 'client.deleted' | 'invoice.created' | 'invoice.sent' | 'invoice.paid' | 'invoice.overdue' | 'quote.created' | 'quote.sent' | 'quote.accepted' | 'quote.rejected' | 'job.created' | 'job.status_changed' | 'job.completed' | 'service_request.created' | 'service_request.assigned';
+/**
+ * Webhook subscription
+ */
+interface Webhook {
+    id: string;
+    business_id: string;
+    name: string;
+    url: string;
+    events: WebhookEvent[];
+    secret: string;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Webhook delivery record
+ */
+interface WebhookDelivery {
+    id: string;
+    webhook_id: string;
+    event_type: WebhookEvent;
+    payload: Record<string, unknown>;
+    response_status: number | null;
+    response_body: string | null;
+    attempt_count: number;
+    next_retry_at: string | null;
+    delivered_at: string | null;
+    failed_at: string | null;
+    created_at: string;
+}
+/**
+ * Options for creating a webhook
+ */
+interface CreateWebhookOptions {
+    name: string;
+    url: string;
+    events: WebhookEvent[];
+}
+/**
+ * Options for updating a webhook
+ */
+interface UpdateWebhookOptions {
+    name?: string;
+    url?: string;
+    events?: WebhookEvent[];
+    is_active?: boolean;
+}
+/**
+ * Options for listing webhook deliveries
+ */
+interface ListWebhookDeliveriesOptions extends ListOptions {
+    event_type?: WebhookEvent;
+}
+
+/**
+ * @file resources/clients.ts
+ * @description Clients resource for the Workbench SDK
+ *
+ * Provides methods for managing clients in Workbench CRM.
+ */
+
+/**
+ * Clients resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // List clients
+ * const { data: clients, pagination } = await workbench.clients.list({
+ *   status: 'active',
+ *   per_page: 10
+ * });
+ *
+ * // Create a client
+ * const { data: client } = await workbench.clients.create({
+ *   first_name: 'John',
+ *   last_name: 'Doe',
+ *   email: 'john@example.com'
+ * });
+ *
+ * // Get a client
+ * const { data: client } = await workbench.clients.get('client-uuid');
+ *
+ * // Update a client
+ * const { data: updated } = await workbench.clients.update('client-uuid', {
+ *   phone: '+1-555-123-4567'
+ * });
+ *
+ * // Delete a client
+ * await workbench.clients.delete('client-uuid');
+ * ```
+ */
+declare class ClientsResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all clients
+     *
+     * Returns a paginated list of clients for the authenticated business.
+     *
+     * @param options - List options (pagination, filtering, sorting)
+     * @returns Paginated list of clients
+     *
+     * @example
+     * ```typescript
+     * // List all active clients
+     * const { data, pagination } = await workbench.clients.list({
+     *   status: 'active',
+     *   page: 1,
+     *   per_page: 20
+     * });
+     *
+     * console.log(`Found ${pagination.total} clients`);
+     * ```
+     */
+    list(options?: ListClientsOptions): Promise<ListResponse<Client>>;
+    /**
+     * Get a client by ID
+     *
+     * @param id - Client UUID
+     * @returns Client details
+     *
+     * @example
+     * ```typescript
+     * const { data: client } = await workbench.clients.get('client-uuid');
+     * console.log(`Client: ${client.first_name} ${client.last_name}`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<Client>>;
+    /**
+     * Create a new client
+     *
+     * @param data - Client data
+     * @returns Created client
+     *
+     * @example
+     * ```typescript
+     * const { data: client } = await workbench.clients.create({
+     *   first_name: 'John',
+     *   last_name: 'Doe',
+     *   email: 'john@example.com',
+     *   phone: '+1-555-123-4567',
+     *   company: 'Acme Corp',
+     *   status: 'active',
+     *   source: 'referral',
+     *   tags: ['vip', 'commercial']
+     * });
+     * ```
+     */
+    create(data: CreateClientOptions): Promise<ApiResponse<Client>>;
+    /**
+     * Update a client
+     *
+     * @param id - Client UUID
+     * @param data - Fields to update
+     * @returns Updated client
+     *
+     * @example
+     * ```typescript
+     * const { data: client } = await workbench.clients.update('client-uuid', {
+     *   status: 'inactive',
+     *   notes: 'Client requested to pause services'
+     * });
+     * ```
+     */
+    update(id: string, data: UpdateClientOptions): Promise<ApiResponse<Client>>;
+    /**
+     * Delete a client
+     *
+     * Permanently deletes a client and all associated data.
+     * This action cannot be undone.
+     *
+     * @param id - Client UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.clients.delete('client-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+}
+
+/**
+ * @file resources/invoices.ts
+ * @description Invoices resource for the Workbench SDK
+ *
+ * Provides methods for managing invoices in Workbench CRM.
+ */
+
+/**
+ * Invoices resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // Create an invoice
+ * const { data: invoice } = await workbench.invoices.create({
+ *   client_id: 'client-uuid',
+ *   items: [
+ *     { description: 'Consulting', quantity: 2, unit_price: 150 },
+ *     { description: 'Materials', quantity: 1, unit_price: 50 }
+ *   ],
+ *   tax_rate: 8.5,
+ *   notes: 'Thank you for your business!'
+ * });
+ *
+ * // Send the invoice
+ * await workbench.invoices.send(invoice.id);
+ * ```
+ */
+declare class InvoicesResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all invoices
+     *
+     * Returns a paginated list of invoices for the authenticated business.
+     *
+     * @param options - List options (pagination, filtering, sorting)
+     * @returns Paginated list of invoices
+     *
+     * @example
+     * ```typescript
+     * // List unpaid invoices
+     * const { data, pagination } = await workbench.invoices.list({
+     *   status: 'sent',
+     *   per_page: 50
+     * });
+     * ```
+     */
+    list(options?: ListInvoicesOptions): Promise<ListResponse<Invoice>>;
+    /**
+     * Get an invoice by ID
+     *
+     * @param id - Invoice UUID
+     * @returns Invoice details with line items
+     *
+     * @example
+     * ```typescript
+     * const { data: invoice } = await workbench.invoices.get('invoice-uuid');
+     * console.log(`Invoice ${invoice.invoice_number}: $${invoice.total}`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<Invoice>>;
+    /**
+     * Create a new invoice
+     *
+     * Creates an invoice with line items. The invoice number is
+     * automatically generated by Workbench.
+     *
+     * @param data - Invoice data including line items
+     * @returns Created invoice
+     *
+     * @example
+     * ```typescript
+     * const { data: invoice } = await workbench.invoices.create({
+     *   client_id: 'client-uuid',
+     *   due_date: '2024-02-15',
+     *   items: [
+     *     { description: 'Web Development', quantity: 10, unit_price: 100 }
+     *   ],
+     *   tax_rate: 8.5,
+     *   notes: 'Payment due within 30 days'
+     * });
+     * ```
+     */
+    create(data: CreateInvoiceOptions): Promise<ApiResponse<Invoice>>;
+    /**
+     * Update an invoice
+     *
+     * If items are provided, they will replace all existing line items.
+     *
+     * @param id - Invoice UUID
+     * @param data - Fields to update
+     * @returns Updated invoice
+     *
+     * @example
+     * ```typescript
+     * const { data: invoice } = await workbench.invoices.update('invoice-uuid', {
+     *   status: 'paid',
+     *   notes: 'Paid via bank transfer on 2024-01-15'
+     * });
+     * ```
+     */
+    update(id: string, data: UpdateInvoiceOptions): Promise<ApiResponse<Invoice>>;
+    /**
+     * Delete an invoice
+     *
+     * Permanently deletes an invoice and all associated line items.
+     * This action cannot be undone.
+     *
+     * @param id - Invoice UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.invoices.delete('invoice-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Send an invoice via email
+     *
+     * Sends the invoice to the client's email address. The invoice
+     * status will be updated to 'sent' if currently 'draft'.
+     *
+     * @param id - Invoice UUID
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * await workbench.invoices.send('invoice-uuid');
+     * console.log('Invoice sent successfully');
+     * ```
+     */
+    send(id: string): Promise<ApiResponse<{
+        message: string;
+        invoice_id: string;
+    }>>;
+}
+
+/**
+ * @file resources/quotes.ts
+ * @description Quotes resource for the Workbench SDK
+ *
+ * Provides methods for managing quotes/estimates in Workbench CRM.
+ */
+
+/**
+ * Quotes resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // Create a quote
+ * const { data: quote } = await workbench.quotes.create({
+ *   client_id: 'client-uuid',
+ *   valid_until: '2024-02-28',
+ *   items: [
+ *     { description: 'Kitchen Renovation', quantity: 1, unit_price: 5000 },
+ *     { description: 'Materials', quantity: 1, unit_price: 2500 }
+ *   ]
+ * });
+ *
+ * // Send the quote
+ * await workbench.quotes.send(quote.id);
+ * ```
+ */
+declare class QuotesResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all quotes
+     *
+     * Returns a paginated list of quotes for the authenticated business.
+     *
+     * @param options - List options (pagination, filtering, sorting)
+     * @returns Paginated list of quotes
+     *
+     * @example
+     * ```typescript
+     * // List pending quotes
+     * const { data, pagination } = await workbench.quotes.list({
+     *   status: 'sent',
+     *   per_page: 20
+     * });
+     * ```
+     */
+    list(options?: ListQuotesOptions): Promise<ListResponse<Quote>>;
+    /**
+     * Get a quote by ID
+     *
+     * @param id - Quote UUID
+     * @returns Quote details with line items
+     *
+     * @example
+     * ```typescript
+     * const { data: quote } = await workbench.quotes.get('quote-uuid');
+     * console.log(`Quote ${quote.quote_number}: $${quote.total}`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<Quote>>;
+    /**
+     * Create a new quote
+     *
+     * Creates a quote with line items. The quote number is
+     * automatically generated by Workbench.
+     *
+     * @param data - Quote data including line items
+     * @returns Created quote
+     *
+     * @example
+     * ```typescript
+     * const { data: quote } = await workbench.quotes.create({
+     *   client_id: 'client-uuid',
+     *   valid_until: '2024-03-01',
+     *   items: [
+     *     { description: 'Plumbing Service', quantity: 4, unit_price: 75 }
+     *   ],
+     *   notes: 'Quote valid for 30 days',
+     *   terms: 'Payment due upon completion'
+     * });
+     * ```
+     */
+    create(data: CreateQuoteOptions): Promise<ApiResponse<Quote>>;
+    /**
+     * Update a quote
+     *
+     * If items are provided, they will replace all existing line items.
+     *
+     * @param id - Quote UUID
+     * @param data - Fields to update
+     * @returns Updated quote
+     *
+     * @example
+     * ```typescript
+     * const { data: quote } = await workbench.quotes.update('quote-uuid', {
+     *   status: 'approved',
+     *   notes: 'Client approved via email on 2024-01-15'
+     * });
+     * ```
+     */
+    update(id: string, data: UpdateQuoteOptions): Promise<ApiResponse<Quote>>;
+    /**
+     * Delete a quote
+     *
+     * Permanently deletes a quote and all associated line items.
+     * This action cannot be undone.
+     *
+     * @param id - Quote UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.quotes.delete('quote-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Send a quote via email
+     *
+     * Sends the quote to the client's email address. The quote
+     * status will be updated to 'sent' if currently 'draft'.
+     *
+     * @param id - Quote UUID
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * await workbench.quotes.send('quote-uuid');
+     * console.log('Quote sent successfully');
+     * ```
+     */
+    send(id: string): Promise<ApiResponse<{
+        message: string;
+        quote_id: string;
+    }>>;
+}
+
+/**
+ * @file resources/jobs.ts
+ * @description Jobs resource for the Workbench SDK
+ *
+ * Provides methods for managing jobs/work orders in Workbench CRM.
+ */
+
+/**
+ * Jobs resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // Create a job
+ * const { data: job } = await workbench.jobs.create({
+ *   client_id: 'client-uuid',
+ *   title: 'Kitchen Faucet Installation',
+ *   priority: 'high',
+ *   scheduled_start: '2024-01-20T09:00:00Z',
+ *   scheduled_end: '2024-01-20T12:00:00Z'
+ * });
+ *
+ * // Update job status
+ * await workbench.jobs.update(job.id, { status: 'completed' });
+ * ```
+ */
+declare class JobsResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all jobs
+     *
+     * Returns a paginated list of jobs for the authenticated business.
+     *
+     * @param options - List options (pagination, filtering, sorting)
+     * @returns Paginated list of jobs
+     *
+     * @example
+     * ```typescript
+     * // List scheduled jobs
+     * const { data, pagination } = await workbench.jobs.list({
+     *   status: 'scheduled',
+     *   priority: 'high',
+     *   per_page: 20
+     * });
+     * ```
+     */
+    list(options?: ListJobsOptions): Promise<ListResponse<Job>>;
+    /**
+     * Get a job by ID
+     *
+     * @param id - Job UUID
+     * @returns Job details
+     *
+     * @example
+     * ```typescript
+     * const { data: job } = await workbench.jobs.get('job-uuid');
+     * console.log(`Job: ${job.title} (${job.status})`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<Job>>;
+    /**
+     * Create a new job
+     *
+     * @param data - Job data
+     * @returns Created job
+     *
+     * @example
+     * ```typescript
+     * const { data: job } = await workbench.jobs.create({
+     *   client_id: 'client-uuid',
+     *   title: 'HVAC Maintenance',
+     *   description: 'Annual AC maintenance and filter replacement',
+     *   priority: 'medium',
+     *   scheduled_start: '2024-01-25T10:00:00Z',
+     *   estimated_duration: 120, // minutes
+     *   notes: 'Customer prefers morning appointments'
+     * });
+     * ```
+     */
+    create(data: CreateJobOptions): Promise<ApiResponse<Job>>;
+    /**
+     * Update a job
+     *
+     * @param id - Job UUID
+     * @param data - Fields to update
+     * @returns Updated job
+     *
+     * @example
+     * ```typescript
+     * // Mark job as started
+     * const { data: job } = await workbench.jobs.update('job-uuid', {
+     *   status: 'in_progress',
+     *   actual_start: new Date().toISOString()
+     * });
+     *
+     * // Mark job as completed
+     * await workbench.jobs.update('job-uuid', {
+     *   status: 'completed',
+     *   actual_end: new Date().toISOString()
+     * });
+     * ```
+     */
+    update(id: string, data: UpdateJobOptions): Promise<ApiResponse<Job>>;
+    /**
+     * Delete a job
+     *
+     * Permanently deletes a job. This action cannot be undone.
+     *
+     * @param id - Job UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.jobs.delete('job-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+}
+
+/**
+ * @file resources/service-requests.ts
+ * @description Service Requests resource for the Workbench SDK
+ *
+ * Provides methods for managing service requests in Workbench CRM.
+ */
+
+/**
+ * Service Requests resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // Create a service request
+ * const { data: request } = await workbench.serviceRequests.create({
+ *   title: 'Leaky Faucet Repair',
+ *   contact_name: 'Jane Smith',
+ *   contact_email: 'jane@example.com',
+ *   contact_phone: '+1-555-987-6543',
+ *   address: '123 Main St, Anytown, USA',
+ *   priority: 'high'
+ * });
+ *
+ * // Update request status
+ * await workbench.serviceRequests.update(request.id, { status: 'scheduled' });
+ * ```
+ */
+declare class ServiceRequestsResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all service requests
+     *
+     * Returns a paginated list of service requests for the authenticated business.
+     *
+     * @param options - List options (pagination, filtering, sorting)
+     * @returns Paginated list of service requests
+     *
+     * @example
+     * ```typescript
+     * // List new requests
+     * const { data, pagination } = await workbench.serviceRequests.list({
+     *   status: 'new',
+     *   priority: 'urgent',
+     *   per_page: 50
+     * });
+     * ```
+     */
+    list(options?: ListServiceRequestsOptions): Promise<ListResponse<ServiceRequest>>;
+    /**
+     * Get a service request by ID
+     *
+     * @param id - Service request UUID
+     * @returns Service request details
+     *
+     * @example
+     * ```typescript
+     * const { data: request } = await workbench.serviceRequests.get('request-uuid');
+     * console.log(`Request: ${request.title} (${request.status})`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<ServiceRequest>>;
+    /**
+     * Create a new service request
+     *
+     * @param data - Service request data
+     * @returns Created service request
+     *
+     * @example
+     * ```typescript
+     * const { data: request } = await workbench.serviceRequests.create({
+     *   title: 'AC Not Cooling',
+     *   description: 'Air conditioner is running but not producing cold air',
+     *   contact_name: 'John Doe',
+     *   contact_email: 'john@example.com',
+     *   contact_phone: '+1-555-123-4567',
+     *   address: '456 Oak Ave, Anytown, USA',
+     *   priority: 'urgent',
+     *   requested_date: '2024-01-20',
+     *   preferred_time: 'Morning (8am-12pm)',
+     *   source: 'website'
+     * });
+     * ```
+     */
+    create(data: CreateServiceRequestOptions): Promise<ApiResponse<ServiceRequest>>;
+    /**
+     * Update a service request
+     *
+     * @param id - Service request UUID
+     * @param data - Fields to update
+     * @returns Updated service request
+     *
+     * @example
+     * ```typescript
+     * // Assign to client and schedule
+     * const { data: request } = await workbench.serviceRequests.update('request-uuid', {
+     *   client_id: 'client-uuid',
+     *   status: 'scheduled',
+     *   notes: 'Scheduled for Monday morning'
+     * });
+     * ```
+     */
+    update(id: string, data: UpdateServiceRequestOptions): Promise<ApiResponse<ServiceRequest>>;
+    /**
+     * Delete a service request
+     *
+     * Permanently deletes a service request. This action cannot be undone.
+     *
+     * @param id - Service request UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.serviceRequests.delete('request-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+}
+
+/**
+ * @file resources/webhooks.ts
+ * @description Webhooks resource for the Workbench SDK
+ *
+ * Provides methods for managing webhook subscriptions in Workbench CRM.
+ */
+
+/**
+ * Webhooks resource
+ *
+ * @example
+ * ```typescript
+ * const workbench = new WorkbenchClient({ apiKey: 'wbk_live_xxx' });
+ *
+ * // Create a webhook
+ * const { data: webhook } = await workbench.webhooks.create({
+ *   name: 'Invoice Notifications',
+ *   url: 'https://example.com/webhooks/workbench',
+ *   events: ['invoice.created', 'invoice.paid']
+ * });
+ *
+ * console.log('Webhook secret:', webhook.secret);
+ * // Store this secret securely to verify webhook signatures
+ * ```
+ */
+declare class WebhooksResource {
+    private readonly client;
+    constructor(client: WorkbenchClient);
+    /**
+     * List all webhooks
+     *
+     * Returns a paginated list of webhook subscriptions for the authenticated business.
+     *
+     * @param options - List options (pagination)
+     * @returns Paginated list of webhooks
+     *
+     * @example
+     * ```typescript
+     * const { data: webhooks } = await workbench.webhooks.list();
+     * webhooks.forEach(webhook => {
+     *   console.log(`${webhook.name}: ${webhook.events.join(', ')}`);
+     * });
+     * ```
+     */
+    list(options?: ListOptions): Promise<ListResponse<Webhook>>;
+    /**
+     * Get a webhook by ID
+     *
+     * @param id - Webhook UUID
+     * @returns Webhook details
+     *
+     * @example
+     * ```typescript
+     * const { data: webhook } = await workbench.webhooks.get('webhook-uuid');
+     * console.log(`Webhook: ${webhook.name}`);
+     * console.log(`Events: ${webhook.events.join(', ')}`);
+     * ```
+     */
+    get(id: string): Promise<ApiResponse<Webhook>>;
+    /**
+     * Create a new webhook
+     *
+     * Creates a webhook subscription. The webhook secret is returned
+     * in the response - store it securely to verify webhook signatures.
+     *
+     * @param data - Webhook data
+     * @returns Created webhook (includes secret)
+     *
+     * @example
+     * ```typescript
+     * const { data: webhook } = await workbench.webhooks.create({
+     *   name: 'All Events',
+     *   url: 'https://example.com/webhooks',
+     *   events: [
+     *     'client.created',
+     *     'client.updated',
+     *     'invoice.created',
+     *     'invoice.paid',
+     *     'quote.accepted',
+     *     'job.completed'
+     *   ]
+     * });
+     *
+     * // IMPORTANT: Store the secret securely!
+     * console.log('Store this secret:', webhook.secret);
+     * ```
+     */
+    create(data: CreateWebhookOptions): Promise<ApiResponse<Webhook>>;
+    /**
+     * Update a webhook
+     *
+     * @param id - Webhook UUID
+     * @param data - Fields to update
+     * @returns Updated webhook
+     *
+     * @example
+     * ```typescript
+     * // Add more events to the webhook
+     * const { data: webhook } = await workbench.webhooks.update('webhook-uuid', {
+     *   events: ['invoice.created', 'invoice.paid', 'invoice.overdue']
+     * });
+     *
+     * // Disable a webhook
+     * await workbench.webhooks.update('webhook-uuid', { is_active: false });
+     * ```
+     */
+    update(id: string, data: UpdateWebhookOptions): Promise<ApiResponse<Webhook>>;
+    /**
+     * Delete a webhook
+     *
+     * Permanently deletes a webhook subscription. No more events
+     * will be sent to this endpoint.
+     *
+     * @param id - Webhook UUID
+     *
+     * @example
+     * ```typescript
+     * await workbench.webhooks.delete('webhook-uuid');
+     * ```
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * List webhook deliveries
+     *
+     * Returns recent delivery attempts for a webhook. Useful for
+     * debugging and monitoring webhook health.
+     *
+     * @param webhookId - Webhook UUID
+     * @param options - List options (pagination, filtering)
+     * @returns Paginated list of delivery attempts
+     *
+     * @example
+     * ```typescript
+     * const { data: deliveries } = await workbench.webhooks.listDeliveries('webhook-uuid', {
+     *   per_page: 50
+     * });
+     *
+     * deliveries.forEach(delivery => {
+     *   const status = delivery.delivered_at ? 'delivered' : 'pending';
+     *   console.log(`${delivery.event_type}: ${status}`);
+     * });
+     * ```
+     */
+    listDeliveries(webhookId: string, options?: ListWebhookDeliveriesOptions): Promise<ListResponse<WebhookDelivery>>;
+    /**
+     * Send a test webhook
+     *
+     * Sends a test event to the webhook endpoint. Useful for
+     * verifying your webhook handler is working correctly.
+     *
+     * @param id - Webhook UUID
+     * @returns Test delivery result
+     *
+     * @example
+     * ```typescript
+     * const { data: result } = await workbench.webhooks.test('webhook-uuid');
+     * console.log('Test delivery:', result);
+     * ```
+     */
+    test(id: string): Promise<ApiResponse<{
+        message: string;
+        delivery_id: string;
+    }>>;
+}
+
+/**
+ * @file client.ts
+ * @description Main Workbench API client class
+ *
+ * The WorkbenchClient is the primary interface for interacting with the
+ * Workbench CRM API. It handles authentication, request management, and
+ * provides access to all API resources.
+ */
+
+/**
+ * Error thrown when an API request fails
+ */
+declare class WorkbenchError extends Error {
+    /** HTTP status code */
+    readonly status: number;
+    /** Error code from the API */
+    readonly code: string;
+    /** Additional error details */
+    readonly details?: Array<{
+        field: string;
+        message: string;
+    }>;
+    /** Request ID for debugging */
+    readonly requestId?: string;
+    constructor(message: string, status: number, code: string, details?: Array<{
+        field: string;
+        message: string;
+    }>, requestId?: string);
+}
+/**
+ * HTTP request options
+ */
+interface RequestOptions {
+    /** HTTP method */
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /** Request path (without base URL) */
+    path: string;
+    /** Query parameters */
+    query?: Record<string, string | number | boolean | undefined>;
+    /** Request body */
+    body?: unknown;
+    /** Additional headers */
+    headers?: Record<string, string>;
+}
+/**
+ * Main Workbench API client
+ *
+ * @example
+ * ```typescript
+ * import { WorkbenchClient } from '@workbench/sdk';
+ *
+ * // Using API key authentication
+ * const workbench = new WorkbenchClient({
+ *   apiKey: 'wbk_live_xxxxxxxxxxxxxxxxxxxxx'
+ * });
+ *
+ * // Using OAuth access token
+ * const workbench = new WorkbenchClient({
+ *   accessToken: 'wbk_at_xxxxxxxxxxxxxxxxxxxxx'
+ * });
+ *
+ * // List clients
+ * const clients = await workbench.clients.list({ page: 1, per_page: 10 });
+ *
+ * // Create an invoice
+ * const invoice = await workbench.invoices.create({
+ *   client_id: 'client-uuid',
+ *   items: [{ description: 'Service', quantity: 1, unit_price: 100 }]
+ * });
+ * ```
+ */
+declare class WorkbenchClient {
+    private readonly baseUrl;
+    private readonly timeout;
+    private readonly maxRetries;
+    private readonly authHeader;
+    /** Clients resource */
+    readonly clients: ClientsResource;
+    /** Invoices resource */
+    readonly invoices: InvoicesResource;
+    /** Quotes resource */
+    readonly quotes: QuotesResource;
+    /** Jobs resource */
+    readonly jobs: JobsResource;
+    /** Service requests resource */
+    readonly serviceRequests: ServiceRequestsResource;
+    /** Webhooks resource */
+    readonly webhooks: WebhooksResource;
+    /**
+     * Create a new Workbench client
+     *
+     * @param config - Client configuration
+     * @throws Error if neither apiKey nor accessToken is provided
+     */
+    constructor(config: WorkbenchConfig);
+    /**
+     * Build URL with query parameters
+     */
+    private buildUrl;
+    /**
+     * Sleep for a specified duration
+     */
+    private sleep;
+    /**
+     * Calculate exponential backoff delay
+     */
+    private getRetryDelay;
+    /**
+     * Determine if an error is retryable
+     */
+    private isRetryable;
+    /**
+     * Make an API request
+     *
+     * @param options - Request options
+     * @returns API response
+     * @throws WorkbenchError if the request fails
+     */
+    request<T>(options: RequestOptions): Promise<T>;
+    /**
+     * Make a GET request
+     */
+    get<T>(path: string, query?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    /**
+     * Make a POST request
+     */
+    post<T>(path: string, body?: unknown): Promise<T>;
+    /**
+     * Make a PUT request
+     */
+    put<T>(path: string, body?: unknown): Promise<T>;
+    /**
+     * Make a DELETE request
+     */
+    delete<T>(path: string): Promise<T>;
+}
+
+/**
+ * @file utils/webhook-verify.ts
+ * @description Utilities for verifying Workbench webhook signatures
+ *
+ * Workbench signs all webhook payloads using HMAC-SHA256. This module provides
+ * utilities to verify these signatures to ensure webhook authenticity.
+ */
+/**
+ * Parsed webhook signature components
+ */
+interface WebhookSignature {
+    /** Unix timestamp when the signature was generated */
+    timestamp: number;
+    /** HMAC-SHA256 signature */
+    signature: string;
+}
+/**
+ * Options for webhook signature verification
+ */
+interface VerifyOptions {
+    /**
+     * Maximum age of the webhook in seconds (default: 300 = 5 minutes)
+     * Set to 0 to disable timestamp validation
+     */
+    tolerance?: number;
+}
+/**
+ * Error thrown when webhook signature verification fails
+ */
+declare class WebhookVerificationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Parse the X-Workbench-Signature header value
+ *
+ * The header format is: t=<timestamp>,v1=<signature>
+ *
+ * @param header - The X-Workbench-Signature header value
+ * @returns Parsed signature components
+ * @throws WebhookVerificationError if the header format is invalid
+ *
+ * @example
+ * ```typescript
+ * const { timestamp, signature } = parseSignatureHeader(
+ *   't=1706400000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd'
+ * );
+ * ```
+ */
+declare function parseSignatureHeader(header: string): WebhookSignature;
+/**
+ * Compute the expected signature for a webhook payload
+ *
+ * @param payload - The raw webhook payload (string or Buffer)
+ * @param secret - The webhook secret
+ * @param timestamp - The timestamp from the signature header
+ * @returns The expected HMAC-SHA256 signature
+ *
+ * @example
+ * ```typescript
+ * const expectedSignature = computeSignature(
+ *   '{"event":"client.created","data":{...}}',
+ *   'whsec_xxxxxxxxxxxx',
+ *   1706400000
+ * );
+ * ```
+ */
+declare function computeSignature(payload: string | Buffer, secret: string, timestamp: number): string;
+/**
+ * Verify a Workbench webhook signature
+ *
+ * This function verifies that a webhook payload was sent by Workbench and
+ * hasn't been tampered with. It also checks that the webhook isn't too old
+ * to prevent replay attacks.
+ *
+ * @param payload - The raw webhook payload (string or Buffer)
+ * @param signature - The X-Workbench-Signature header value
+ * @param secret - Your webhook secret (starts with whsec_)
+ * @param options - Verification options
+ * @returns true if the signature is valid
+ * @throws WebhookVerificationError if verification fails
+ *
+ * @example
+ * ```typescript
+ * import { verifyWebhookSignature } from '@workbench/sdk';
+ *
+ * app.post('/webhooks', express.raw({ type: 'application/json' }), (req, res) => {
+ *   const signature = req.headers['x-workbench-signature'] as string;
+ *
+ *   try {
+ *     verifyWebhookSignature(req.body, signature, process.env.WEBHOOK_SECRET!);
+ *
+ *     // Process the webhook
+ *     const event = JSON.parse(req.body.toString());
+ *     console.log('Received event:', event.event);
+ *
+ *     res.sendStatus(200);
+ *   } catch (error) {
+ *     console.error('Webhook verification failed:', error);
+ *     res.sendStatus(400);
+ *   }
+ * });
+ * ```
+ */
+declare function verifyWebhookSignature(payload: string | Buffer, signature: string, secret: string, options?: VerifyOptions): boolean;
+/**
+ * Construct a webhook event from a verified payload
+ *
+ * This is a convenience function that verifies the signature and parses
+ * the payload in one step.
+ *
+ * @param payload - The raw webhook payload (string or Buffer)
+ * @param signature - The X-Workbench-Signature header value
+ * @param secret - Your webhook secret
+ * @param options - Verification options
+ * @returns The parsed webhook event
+ * @throws WebhookVerificationError if verification fails
+ *
+ * @example
+ * ```typescript
+ * import { constructWebhookEvent } from '@workbench/sdk';
+ *
+ * const event = constructWebhookEvent(req.body, signature, secret);
+ * console.log('Event type:', event.event);
+ * console.log('Event data:', event.data);
+ * ```
+ */
+declare function constructWebhookEvent<T = Record<string, unknown>>(payload: string | Buffer, signature: string, secret: string, options?: VerifyOptions): {
+    event: string;
+    data: T;
+    timestamp: string;
+};
+
+export { type ApiError, type ApiResponse, type Client, type ClientStatus, ClientsResource, type CreateClientOptions, type CreateInvoiceOptions, type CreateJobOptions, type CreateQuoteOptions, type CreateServiceRequestOptions, type CreateWebhookOptions, type Invoice, type InvoiceItem, type InvoiceStatus, InvoicesResource, type Job, type JobPriority, type JobStatus, JobsResource, type ListClientsOptions, type ListInvoicesOptions, type ListJobsOptions, type ListOptions, type ListQuotesOptions, type ListResponse, type ListServiceRequestsOptions, type ListWebhookDeliveriesOptions, type Pagination, type Quote, type QuoteItem, type QuoteStatus, QuotesResource, type RequestOptions, type ResponseMeta, type ServiceRequest, type ServiceRequestPriority, type ServiceRequestStatus, ServiceRequestsResource, type UpdateClientOptions, type UpdateInvoiceOptions, type UpdateJobOptions, type UpdateQuoteOptions, type UpdateServiceRequestOptions, type UpdateWebhookOptions, type VerifyOptions, type Webhook, type WebhookDelivery, type WebhookEvent, type WebhookSignature, WebhookVerificationError, WebhooksResource, WorkbenchClient, type WorkbenchConfig, WorkbenchError, computeSignature, constructWebhookEvent, parseSignatureHeader, verifyWebhookSignature };