@workbenchcrm/sdk 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -28,6 +28,10 @@ interface ListOptions {
     page?: number;
     /** Items per page (1-100, defaults to 20) */
     per_page?: number;
+    /** Limit (alternative to per_page for offset-based pagination) */
+    limit?: number;
+    /** Offset for offset-based pagination */
+    offset?: number;
     /** Search query string */
     search?: string;
     /** Field to sort by */
@@ -46,17 +50,22 @@ interface ResponseMeta {
 }
 /**
  * Pagination information for list responses
+ * Supports both page-based and offset-based pagination
  */
 interface Pagination {
-    /** Current page number */
-    page: number;
-    /** Items per page */
-    per_page: number;
+    /** Current page number (page-based) */
+    page?: number;
+    /** Items per page (page-based) */
+    per_page?: number;
     /** Total number of items */
     total: number;
-    /** Total number of pages */
-    total_pages: number;
-    /** Whether there's a next page */
+    /** Total number of pages (page-based) */
+    total_pages?: number;
+    /** Limit used for the query (offset-based) */
+    limit?: number;
+    /** Offset used for the query (offset-based) */
+    offset?: number;
+    /** Whether there are more items available */
     has_more: boolean;
 }
 /**
@@ -106,11 +115,13 @@ interface Client {
     status: ClientStatus;
     source: string | null;
     notes: string | null;
+    /** Internal notes visible only to business users */
+    internal_notes: string | null;
     tags: string[] | null;
     next_contact_date: string | null;
     ask_for_review: boolean | null;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a client
@@ -124,6 +135,7 @@ interface CreateClientOptions {
     status?: ClientStatus;
     source?: string | null;
     notes?: string | null;
+    internal_notes?: string | null;
     tags?: string[] | null;
 }
 /**
@@ -142,7 +154,7 @@ interface ListClientsOptions extends ListOptions {
 /**
  * Invoice status values
  */
-type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'overdue' | 'cancelled';
+type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'overdue' | 'cancelled' | 'voided';
 /**
  * Invoice line item
  */
@@ -173,10 +185,14 @@ interface Invoice {
     amount_paid: number;
     notes: string | null;
     terms: string | null;
+    /** Timestamp when the invoice was sent to the client */
+    sent_at: string | null;
+    /** Timestamp when the invoice was fully paid */
+    paid_at: string | null;
     items: InvoiceItem[];
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating an invoice
@@ -239,10 +255,16 @@ interface Quote {
     total: number;
     notes: string | null;
     terms: string | null;
+    /** Timestamp when the quote was sent to the client */
+    sent_at: string | null;
+    /** Timestamp when the quote was approved/accepted */
+    approved_at: string | null;
+    /** User ID or name of who approved the quote */
+    approved_by: string | null;
     items: QuoteItem[];
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a quote
@@ -287,6 +309,8 @@ interface Job {
     id: string;
     business_id: string;
     client_id: string | null;
+    /** Unique job number for display/reference */
+    job_number: string | null;
     title: string;
     description: string | null;
     status: JobStatus;
@@ -300,7 +324,7 @@ interface Job {
     notes: string | null;
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a job
@@ -361,7 +385,7 @@ interface ServiceRequest {
     notes: string | null;
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a service request
@@ -396,7 +420,7 @@ interface ListServiceRequestsOptions extends ListOptions {
 /**
  * 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';
+type WebhookEvent = 'client.created' | 'client.updated' | 'client.deleted' | 'invoice.created' | 'invoice.updated' | 'invoice.sent' | 'invoice.viewed' | 'invoice.paid' | 'invoice.overdue' | 'invoice.voided' | 'quote.created' | 'quote.updated' | 'quote.sent' | 'quote.viewed' | 'quote.accepted' | 'quote.rejected' | 'quote.expired' | 'job.created' | 'job.updated' | 'job.status_changed' | 'job.completed' | 'job.cancelled' | 'service_request.created' | 'service_request.updated' | 'service_request.assigned' | 'service_request.completed';
 /**
  * Webhook subscription
  */
@@ -408,8 +432,20 @@ interface Webhook {
     events: WebhookEvent[];
     secret: string;
     is_active: boolean;
+    /** Custom metadata attached to the webhook */
+    metadata: Record<string, unknown> | null;
+    /** Number of consecutive delivery failures */
+    failure_count: number;
+    /** Timestamp of the last webhook trigger */
+    last_triggered_at: string | null;
+    /** Timestamp of the last successful delivery */
+    last_success_at: string | null;
+    /** Timestamp of the last failed delivery */
+    last_failure_at: string | null;
+    /** User ID who created the webhook */
+    created_by: string | null;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Webhook delivery record
@@ -417,14 +453,26 @@ interface Webhook {
 interface WebhookDelivery {
     id: string;
     webhook_id: string;
+    /** Unique event ID for idempotency */
+    event_id: string;
     event_type: WebhookEvent;
     payload: Record<string, unknown>;
+    /** Headers sent with the webhook request */
+    request_headers: Record<string, string> | null;
     response_status: number | null;
+    /** Headers received in the response */
+    response_headers: Record<string, string> | null;
     response_body: string | null;
+    /** Response time in milliseconds */
+    response_time_ms: number | null;
     attempt_count: number;
+    /** Maximum number of delivery attempts */
+    max_attempts: number;
     next_retry_at: string | null;
     delivered_at: string | null;
     failed_at: string | null;
+    /** Error message if delivery failed */
+    error_message: string | null;
     created_at: string;
 }
 /**
@@ -434,6 +482,8 @@ interface CreateWebhookOptions {
     name: string;
     url: string;
     events: WebhookEvent[];
+    /** Custom metadata to attach to the webhook */
+    metadata?: Record<string, unknown>;
 }
 /**
  * Options for updating a webhook
@@ -443,12 +493,29 @@ interface UpdateWebhookOptions {
     url?: string;
     events?: WebhookEvent[];
     is_active?: boolean;
+    metadata?: Record<string, unknown>;
 }
 /**
  * Options for listing webhook deliveries
  */
 interface ListWebhookDeliveriesOptions extends ListOptions {
     event_type?: WebhookEvent;
+    /** Filter by delivery status */
+    status?: 'pending' | 'delivered' | 'failed';
+}
+/**
+ * Response from regenerating a webhook secret
+ */
+interface WebhookSecretResponse {
+    secret: string;
+}
+/**
+ * Webhook event type information
+ */
+interface WebhookEventTypeInfo {
+    event: WebhookEvent;
+    description: string;
+    category: 'client' | 'invoice' | 'quote' | 'job' | 'service_request';
 }
 
 /**
@@ -1259,6 +1326,62 @@ declare class WebhooksResource {
         message: string;
         delivery_id: string;
     }>>;
+    /**
+     * Get a single webhook delivery
+     *
+     * Returns details about a specific delivery attempt, including
+     * request/response headers and timing information.
+     *
+     * @param webhookId - Webhook UUID
+     * @param deliveryId - Delivery UUID
+     * @returns Delivery details
+     *
+     * @example
+     * ```typescript
+     * const { data: delivery } = await workbench.webhooks.getDelivery(
+     *   'webhook-uuid',
+     *   'delivery-uuid'
+     * );
+     * console.log(`Status: ${delivery.response_status}`);
+     * console.log(`Response time: ${delivery.response_time_ms}ms`);
+     * ```
+     */
+    getDelivery(webhookId: string, deliveryId: string): Promise<ApiResponse<WebhookDelivery>>;
+    /**
+     * Regenerate webhook secret
+     *
+     * Generates a new secret for the webhook. The old secret will
+     * immediately stop working. Make sure to update your webhook
+     * handler with the new secret.
+     *
+     * @param id - Webhook UUID
+     * @returns New webhook secret
+     *
+     * @example
+     * ```typescript
+     * const { data } = await workbench.webhooks.regenerateSecret('webhook-uuid');
+     * console.log('New secret:', data.secret);
+     * // Update your webhook handler with the new secret!
+     * ```
+     */
+    regenerateSecret(id: string): Promise<ApiResponse<WebhookSecretResponse>>;
+    /**
+     * List available webhook event types
+     *
+     * Returns all event types that can be subscribed to, with
+     * descriptions and categories.
+     *
+     * @returns List of available event types
+     *
+     * @example
+     * ```typescript
+     * const { data: eventTypes } = await workbench.webhooks.listEventTypes();
+     * eventTypes.forEach(et => {
+     *   console.log(`${et.event} (${et.category}): ${et.description}`);
+     * });
+     * ```
+     */
+    listEventTypes(): Promise<ApiResponse<WebhookEventTypeInfo[]>>;
 }
 
 /**

package/dist/index.d.ts

@@ -28,6 +28,10 @@ interface ListOptions {
     page?: number;
     /** Items per page (1-100, defaults to 20) */
     per_page?: number;
+    /** Limit (alternative to per_page for offset-based pagination) */
+    limit?: number;
+    /** Offset for offset-based pagination */
+    offset?: number;
     /** Search query string */
     search?: string;
     /** Field to sort by */
@@ -46,17 +50,22 @@ interface ResponseMeta {
 }
 /**
  * Pagination information for list responses
+ * Supports both page-based and offset-based pagination
  */
 interface Pagination {
-    /** Current page number */
-    page: number;
-    /** Items per page */
-    per_page: number;
+    /** Current page number (page-based) */
+    page?: number;
+    /** Items per page (page-based) */
+    per_page?: number;
     /** Total number of items */
     total: number;
-    /** Total number of pages */
-    total_pages: number;
-    /** Whether there's a next page */
+    /** Total number of pages (page-based) */
+    total_pages?: number;
+    /** Limit used for the query (offset-based) */
+    limit?: number;
+    /** Offset used for the query (offset-based) */
+    offset?: number;
+    /** Whether there are more items available */
     has_more: boolean;
 }
 /**
@@ -106,11 +115,13 @@ interface Client {
     status: ClientStatus;
     source: string | null;
     notes: string | null;
+    /** Internal notes visible only to business users */
+    internal_notes: string | null;
     tags: string[] | null;
     next_contact_date: string | null;
     ask_for_review: boolean | null;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a client
@@ -124,6 +135,7 @@ interface CreateClientOptions {
     status?: ClientStatus;
     source?: string | null;
     notes?: string | null;
+    internal_notes?: string | null;
     tags?: string[] | null;
 }
 /**
@@ -142,7 +154,7 @@ interface ListClientsOptions extends ListOptions {
 /**
  * Invoice status values
  */
-type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'overdue' | 'cancelled';
+type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'overdue' | 'cancelled' | 'voided';
 /**
  * Invoice line item
  */
@@ -173,10 +185,14 @@ interface Invoice {
     amount_paid: number;
     notes: string | null;
     terms: string | null;
+    /** Timestamp when the invoice was sent to the client */
+    sent_at: string | null;
+    /** Timestamp when the invoice was fully paid */
+    paid_at: string | null;
     items: InvoiceItem[];
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating an invoice
@@ -239,10 +255,16 @@ interface Quote {
     total: number;
     notes: string | null;
     terms: string | null;
+    /** Timestamp when the quote was sent to the client */
+    sent_at: string | null;
+    /** Timestamp when the quote was approved/accepted */
+    approved_at: string | null;
+    /** User ID or name of who approved the quote */
+    approved_by: string | null;
     items: QuoteItem[];
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a quote
@@ -287,6 +309,8 @@ interface Job {
     id: string;
     business_id: string;
     client_id: string | null;
+    /** Unique job number for display/reference */
+    job_number: string | null;
     title: string;
     description: string | null;
     status: JobStatus;
@@ -300,7 +324,7 @@ interface Job {
     notes: string | null;
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a job
@@ -361,7 +385,7 @@ interface ServiceRequest {
     notes: string | null;
     client?: Client;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Options for creating a service request
@@ -396,7 +420,7 @@ interface ListServiceRequestsOptions extends ListOptions {
 /**
  * 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';
+type WebhookEvent = 'client.created' | 'client.updated' | 'client.deleted' | 'invoice.created' | 'invoice.updated' | 'invoice.sent' | 'invoice.viewed' | 'invoice.paid' | 'invoice.overdue' | 'invoice.voided' | 'quote.created' | 'quote.updated' | 'quote.sent' | 'quote.viewed' | 'quote.accepted' | 'quote.rejected' | 'quote.expired' | 'job.created' | 'job.updated' | 'job.status_changed' | 'job.completed' | 'job.cancelled' | 'service_request.created' | 'service_request.updated' | 'service_request.assigned' | 'service_request.completed';
 /**
  * Webhook subscription
  */
@@ -408,8 +432,20 @@ interface Webhook {
     events: WebhookEvent[];
     secret: string;
     is_active: boolean;
+    /** Custom metadata attached to the webhook */
+    metadata: Record<string, unknown> | null;
+    /** Number of consecutive delivery failures */
+    failure_count: number;
+    /** Timestamp of the last webhook trigger */
+    last_triggered_at: string | null;
+    /** Timestamp of the last successful delivery */
+    last_success_at: string | null;
+    /** Timestamp of the last failed delivery */
+    last_failure_at: string | null;
+    /** User ID who created the webhook */
+    created_by: string | null;
     created_at: string;
-    updated_at: string;
+    updated_at: string | null;
 }
 /**
  * Webhook delivery record
@@ -417,14 +453,26 @@ interface Webhook {
 interface WebhookDelivery {
     id: string;
     webhook_id: string;
+    /** Unique event ID for idempotency */
+    event_id: string;
     event_type: WebhookEvent;
     payload: Record<string, unknown>;
+    /** Headers sent with the webhook request */
+    request_headers: Record<string, string> | null;
     response_status: number | null;
+    /** Headers received in the response */
+    response_headers: Record<string, string> | null;
     response_body: string | null;
+    /** Response time in milliseconds */
+    response_time_ms: number | null;
     attempt_count: number;
+    /** Maximum number of delivery attempts */
+    max_attempts: number;
     next_retry_at: string | null;
     delivered_at: string | null;
     failed_at: string | null;
+    /** Error message if delivery failed */
+    error_message: string | null;
     created_at: string;
 }
 /**
@@ -434,6 +482,8 @@ interface CreateWebhookOptions {
     name: string;
     url: string;
     events: WebhookEvent[];
+    /** Custom metadata to attach to the webhook */
+    metadata?: Record<string, unknown>;
 }
 /**
  * Options for updating a webhook
@@ -443,12 +493,29 @@ interface UpdateWebhookOptions {
     url?: string;
     events?: WebhookEvent[];
     is_active?: boolean;
+    metadata?: Record<string, unknown>;
 }
 /**
  * Options for listing webhook deliveries
  */
 interface ListWebhookDeliveriesOptions extends ListOptions {
     event_type?: WebhookEvent;
+    /** Filter by delivery status */
+    status?: 'pending' | 'delivered' | 'failed';
+}
+/**
+ * Response from regenerating a webhook secret
+ */
+interface WebhookSecretResponse {
+    secret: string;
+}
+/**
+ * Webhook event type information
+ */
+interface WebhookEventTypeInfo {
+    event: WebhookEvent;
+    description: string;
+    category: 'client' | 'invoice' | 'quote' | 'job' | 'service_request';
 }
 
 /**
@@ -1259,6 +1326,62 @@ declare class WebhooksResource {
         message: string;
         delivery_id: string;
     }>>;
+    /**
+     * Get a single webhook delivery
+     *
+     * Returns details about a specific delivery attempt, including
+     * request/response headers and timing information.
+     *
+     * @param webhookId - Webhook UUID
+     * @param deliveryId - Delivery UUID
+     * @returns Delivery details
+     *
+     * @example
+     * ```typescript
+     * const { data: delivery } = await workbench.webhooks.getDelivery(
+     *   'webhook-uuid',
+     *   'delivery-uuid'
+     * );
+     * console.log(`Status: ${delivery.response_status}`);
+     * console.log(`Response time: ${delivery.response_time_ms}ms`);
+     * ```
+     */
+    getDelivery(webhookId: string, deliveryId: string): Promise<ApiResponse<WebhookDelivery>>;
+    /**
+     * Regenerate webhook secret
+     *
+     * Generates a new secret for the webhook. The old secret will
+     * immediately stop working. Make sure to update your webhook
+     * handler with the new secret.
+     *
+     * @param id - Webhook UUID
+     * @returns New webhook secret
+     *
+     * @example
+     * ```typescript
+     * const { data } = await workbench.webhooks.regenerateSecret('webhook-uuid');
+     * console.log('New secret:', data.secret);
+     * // Update your webhook handler with the new secret!
+     * ```
+     */
+    regenerateSecret(id: string): Promise<ApiResponse<WebhookSecretResponse>>;
+    /**
+     * List available webhook event types
+     *
+     * Returns all event types that can be subscribed to, with
+     * descriptions and categories.
+     *
+     * @returns List of available event types
+     *
+     * @example
+     * ```typescript
+     * const { data: eventTypes } = await workbench.webhooks.listEventTypes();
+     * eventTypes.forEach(et => {
+     *   console.log(`${et.event} (${et.category}): ${et.description}`);
+     * });
+     * ```
+     */
+    listEventTypes(): Promise<ApiResponse<WebhookEventTypeInfo[]>>;
 }
 
 /**

package/dist/index.js

@@ -793,6 +793,70 @@ var WebhooksResource = class {
   async test(id) {
     return this.client.post(`/v1/webhooks/${id}/test`);
   }
+  /**
+   * Get a single webhook delivery
+   *
+   * Returns details about a specific delivery attempt, including
+   * request/response headers and timing information.
+   *
+   * @param webhookId - Webhook UUID
+   * @param deliveryId - Delivery UUID
+   * @returns Delivery details
+   *
+   * @example
+   * ```typescript
+   * const { data: delivery } = await workbench.webhooks.getDelivery(
+   *   'webhook-uuid',
+   *   'delivery-uuid'
+   * );
+   * console.log(`Status: ${delivery.response_status}`);
+   * console.log(`Response time: ${delivery.response_time_ms}ms`);
+   * ```
+   */
+  async getDelivery(webhookId, deliveryId) {
+    return this.client.get(
+      `/v1/webhooks/${webhookId}/deliveries/${deliveryId}`
+    );
+  }
+  /**
+   * Regenerate webhook secret
+   *
+   * Generates a new secret for the webhook. The old secret will
+   * immediately stop working. Make sure to update your webhook
+   * handler with the new secret.
+   *
+   * @param id - Webhook UUID
+   * @returns New webhook secret
+   *
+   * @example
+   * ```typescript
+   * const { data } = await workbench.webhooks.regenerateSecret('webhook-uuid');
+   * console.log('New secret:', data.secret);
+   * // Update your webhook handler with the new secret!
+   * ```
+   */
+  async regenerateSecret(id) {
+    return this.client.post(`/v1/webhooks/${id}/secret`);
+  }
+  /**
+   * List available webhook event types
+   *
+   * Returns all event types that can be subscribed to, with
+   * descriptions and categories.
+   *
+   * @returns List of available event types
+   *
+   * @example
+   * ```typescript
+   * const { data: eventTypes } = await workbench.webhooks.listEventTypes();
+   * eventTypes.forEach(et => {
+   *   console.log(`${et.event} (${et.category}): ${et.description}`);
+   * });
+   * ```
+   */
+  async listEventTypes() {
+    return this.client.get("/v1/webhooks/event-types");
+  }
 };
 
 // src/client.ts

package/dist/index.mjs

@@ -755,6 +755,70 @@ var WebhooksResource = class {
   async test(id) {
     return this.client.post(`/v1/webhooks/${id}/test`);
   }
+  /**
+   * Get a single webhook delivery
+   *
+   * Returns details about a specific delivery attempt, including
+   * request/response headers and timing information.
+   *
+   * @param webhookId - Webhook UUID
+   * @param deliveryId - Delivery UUID
+   * @returns Delivery details
+   *
+   * @example
+   * ```typescript
+   * const { data: delivery } = await workbench.webhooks.getDelivery(
+   *   'webhook-uuid',
+   *   'delivery-uuid'
+   * );
+   * console.log(`Status: ${delivery.response_status}`);
+   * console.log(`Response time: ${delivery.response_time_ms}ms`);
+   * ```
+   */
+  async getDelivery(webhookId, deliveryId) {
+    return this.client.get(
+      `/v1/webhooks/${webhookId}/deliveries/${deliveryId}`
+    );
+  }
+  /**
+   * Regenerate webhook secret
+   *
+   * Generates a new secret for the webhook. The old secret will
+   * immediately stop working. Make sure to update your webhook
+   * handler with the new secret.
+   *
+   * @param id - Webhook UUID
+   * @returns New webhook secret
+   *
+   * @example
+   * ```typescript
+   * const { data } = await workbench.webhooks.regenerateSecret('webhook-uuid');
+   * console.log('New secret:', data.secret);
+   * // Update your webhook handler with the new secret!
+   * ```
+   */
+  async regenerateSecret(id) {
+    return this.client.post(`/v1/webhooks/${id}/secret`);
+  }
+  /**
+   * List available webhook event types
+   *
+   * Returns all event types that can be subscribed to, with
+   * descriptions and categories.
+   *
+   * @returns List of available event types
+   *
+   * @example
+   * ```typescript
+   * const { data: eventTypes } = await workbench.webhooks.listEventTypes();
+   * eventTypes.forEach(et => {
+   *   console.log(`${et.event} (${et.category}): ${et.description}`);
+   * });
+   * ```
+   */
+  async listEventTypes() {
+    return this.client.get("/v1/webhooks/event-types");
+  }
 };
 
 // src/client.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workbenchcrm/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Official Node.js SDK for the Workbench CRM API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",