ark-email 0.5.1

package/resources/webhooks.d.mts

@@ -0,0 +1,307 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Webhooks extends APIResource {
+    /**
+     * Create a webhook endpoint to receive email event notifications.
+     *
+     * **Available events:**
+     *
+     * - `MessageSent` - Email accepted by recipient server
+     * - `MessageDeliveryFailed` - Delivery permanently failed
+     * - `MessageDelayed` - Delivery temporarily failed, will retry
+     * - `MessageBounced` - Email bounced
+     * - `MessageHeld` - Email held for review
+     * - `MessageLinkClicked` - Recipient clicked a link
+     * - `MessageLoaded` - Recipient opened the email
+     * - `DomainDNSError` - Domain DNS issue detected
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   events: [
+     *     'MessageSent',
+     *     'MessageDeliveryFailed',
+     *     'MessageBounced',
+     *   ],
+     *   name: 'My App Webhook',
+     *   url: 'https://myapp.com/webhooks/email',
+     * });
+     * ```
+     */
+    create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
+    /**
+     * Get webhook details
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve('webhookId');
+     * ```
+     */
+    retrieve(webhookID: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    /**
+     * Update a webhook
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update('webhookId');
+     * ```
+     */
+    update(webhookID: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    /**
+     * Get all configured webhook endpoints
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<WebhookListResponse>;
+    /**
+     * Delete a webhook
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.delete('webhookId');
+     * ```
+     */
+    delete(webhookID: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
+    /**
+     * Send a test payload to your webhook endpoint and verify it receives the data
+     * correctly.
+     *
+     * Use this to:
+     *
+     * - Verify your webhook URL is accessible
+     * - Test your signature verification code
+     * - Ensure your server handles the payload format correctly
+     *
+     * **Test payload format:** The test payload is identical to real webhook payloads,
+     * containing sample data for the specified event type. Your webhook should respond
+     * with a 2xx status code.
+     *
+     * @example
+     * ```ts
+     * const response = await client.webhooks.test('webhookId', {
+     *   event: 'MessageSent',
+     * });
+     * ```
+     */
+    test(webhookID: string, body: WebhookTestParams, options?: RequestOptions): APIPromise<WebhookTestResponse>;
+}
+export interface WebhookCreateResponse {
+    data: WebhookCreateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookCreateResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookRetrieveResponse {
+    data: WebhookRetrieveResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookRetrieveResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookUpdateResponse {
+    data: WebhookUpdateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookUpdateResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookListResponse {
+    data: WebhookListResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookListResponse {
+    interface Data {
+        webhooks: Array<Data.Webhook>;
+    }
+    namespace Data {
+        interface Webhook {
+            /**
+             * Webhook ID
+             */
+            id: string;
+            enabled: boolean;
+            events: Array<string>;
+            name: string;
+            url: string;
+        }
+    }
+}
+export interface WebhookDeleteResponse {
+    data: WebhookDeleteResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookDeleteResponse {
+    interface Data {
+        message: string;
+    }
+}
+export interface WebhookTestResponse {
+    data: WebhookTestResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookTestResponse {
+    interface Data {
+        /**
+         * Request duration in milliseconds
+         */
+        duration: number;
+        /**
+         * Event type that was tested
+         */
+        event: string;
+        /**
+         * HTTP status code from the webhook endpoint
+         */
+        statusCode: number | null;
+        /**
+         * Whether the webhook endpoint responded with a 2xx status
+         */
+        success: boolean;
+        /**
+         * Response body from the webhook endpoint (truncated if too long)
+         */
+        body?: string | null;
+        /**
+         * Error message if the request failed
+         */
+        error?: string | null;
+    }
+}
+export interface WebhookCreateParams {
+    /**
+     * Events to subscribe to:
+     *
+     * - `MessageSent` - Email successfully delivered to recipient's server
+     * - `MessageDelayed` - Temporary delivery failure, will retry
+     * - `MessageDeliveryFailed` - Permanent delivery failure
+     * - `MessageHeld` - Email held for manual review
+     * - `MessageBounced` - Email bounced back
+     * - `MessageLinkClicked` - Recipient clicked a tracked link
+     * - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
+     * - `DomainDNSError` - DNS configuration issue detected
+     */
+    events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+    /**
+     * Webhook name for identification
+     */
+    name: string;
+    /**
+     * HTTPS endpoint URL
+     */
+    url: string;
+    /**
+     * Subscribe to all events (ignores events array)
+     */
+    allEvents?: boolean;
+    enabled?: boolean;
+}
+export interface WebhookUpdateParams {
+    allEvents?: boolean;
+    enabled?: boolean;
+    events?: Array<string>;
+    name?: string;
+    url?: string;
+}
+export interface WebhookTestParams {
+    /**
+     * Event type to simulate
+     */
+    event: 'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError';
+}
+export declare namespace Webhooks {
+    export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookRetrieveResponse as WebhookRetrieveResponse, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookTestParams as WebhookTestParams, };
+}
+//# sourceMappingURL=webhooks.d.mts.map

package/resources/webhooks.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;OAOG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX,OAAO,EAAE,OAAO,CAAC;YAEjB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,IAAI,EAAE,MAAM,CAAC;YAEb,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EACD,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/webhooks.d.ts

@@ -0,0 +1,307 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Webhooks extends APIResource {
+    /**
+     * Create a webhook endpoint to receive email event notifications.
+     *
+     * **Available events:**
+     *
+     * - `MessageSent` - Email accepted by recipient server
+     * - `MessageDeliveryFailed` - Delivery permanently failed
+     * - `MessageDelayed` - Delivery temporarily failed, will retry
+     * - `MessageBounced` - Email bounced
+     * - `MessageHeld` - Email held for review
+     * - `MessageLinkClicked` - Recipient clicked a link
+     * - `MessageLoaded` - Recipient opened the email
+     * - `DomainDNSError` - Domain DNS issue detected
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   events: [
+     *     'MessageSent',
+     *     'MessageDeliveryFailed',
+     *     'MessageBounced',
+     *   ],
+     *   name: 'My App Webhook',
+     *   url: 'https://myapp.com/webhooks/email',
+     * });
+     * ```
+     */
+    create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
+    /**
+     * Get webhook details
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve('webhookId');
+     * ```
+     */
+    retrieve(webhookID: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    /**
+     * Update a webhook
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update('webhookId');
+     * ```
+     */
+    update(webhookID: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    /**
+     * Get all configured webhook endpoints
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<WebhookListResponse>;
+    /**
+     * Delete a webhook
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.delete('webhookId');
+     * ```
+     */
+    delete(webhookID: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
+    /**
+     * Send a test payload to your webhook endpoint and verify it receives the data
+     * correctly.
+     *
+     * Use this to:
+     *
+     * - Verify your webhook URL is accessible
+     * - Test your signature verification code
+     * - Ensure your server handles the payload format correctly
+     *
+     * **Test payload format:** The test payload is identical to real webhook payloads,
+     * containing sample data for the specified event type. Your webhook should respond
+     * with a 2xx status code.
+     *
+     * @example
+     * ```ts
+     * const response = await client.webhooks.test('webhookId', {
+     *   event: 'MessageSent',
+     * });
+     * ```
+     */
+    test(webhookID: string, body: WebhookTestParams, options?: RequestOptions): APIPromise<WebhookTestResponse>;
+}
+export interface WebhookCreateResponse {
+    data: WebhookCreateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookCreateResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookRetrieveResponse {
+    data: WebhookRetrieveResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookRetrieveResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookUpdateResponse {
+    data: WebhookUpdateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookUpdateResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Whether subscribed to all events
+         */
+        allEvents: boolean;
+        createdAt: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+        /**
+         * Webhook name for identification
+         */
+        name: string;
+        /**
+         * Webhook endpoint URL
+         */
+        url: string;
+        uuid: string;
+    }
+}
+export interface WebhookListResponse {
+    data: WebhookListResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookListResponse {
+    interface Data {
+        webhooks: Array<Data.Webhook>;
+    }
+    namespace Data {
+        interface Webhook {
+            /**
+             * Webhook ID
+             */
+            id: string;
+            enabled: boolean;
+            events: Array<string>;
+            name: string;
+            url: string;
+        }
+    }
+}
+export interface WebhookDeleteResponse {
+    data: WebhookDeleteResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookDeleteResponse {
+    interface Data {
+        message: string;
+    }
+}
+export interface WebhookTestResponse {
+    data: WebhookTestResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace WebhookTestResponse {
+    interface Data {
+        /**
+         * Request duration in milliseconds
+         */
+        duration: number;
+        /**
+         * Event type that was tested
+         */
+        event: string;
+        /**
+         * HTTP status code from the webhook endpoint
+         */
+        statusCode: number | null;
+        /**
+         * Whether the webhook endpoint responded with a 2xx status
+         */
+        success: boolean;
+        /**
+         * Response body from the webhook endpoint (truncated if too long)
+         */
+        body?: string | null;
+        /**
+         * Error message if the request failed
+         */
+        error?: string | null;
+    }
+}
+export interface WebhookCreateParams {
+    /**
+     * Events to subscribe to:
+     *
+     * - `MessageSent` - Email successfully delivered to recipient's server
+     * - `MessageDelayed` - Temporary delivery failure, will retry
+     * - `MessageDeliveryFailed` - Permanent delivery failure
+     * - `MessageHeld` - Email held for manual review
+     * - `MessageBounced` - Email bounced back
+     * - `MessageLinkClicked` - Recipient clicked a tracked link
+     * - `MessageLoaded` - Recipient opened the email (tracking pixel loaded)
+     * - `DomainDNSError` - DNS configuration issue detected
+     */
+    events: Array<'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'>;
+    /**
+     * Webhook name for identification
+     */
+    name: string;
+    /**
+     * HTTPS endpoint URL
+     */
+    url: string;
+    /**
+     * Subscribe to all events (ignores events array)
+     */
+    allEvents?: boolean;
+    enabled?: boolean;
+}
+export interface WebhookUpdateParams {
+    allEvents?: boolean;
+    enabled?: boolean;
+    events?: Array<string>;
+    name?: string;
+    url?: string;
+}
+export interface WebhookTestParams {
+    /**
+     * Event type to simulate
+     */
+    event: 'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError';
+}
+export declare namespace Webhooks {
+    export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookRetrieveResponse as WebhookRetrieveResponse, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookTestParams as WebhookTestParams, };
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/resources/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;OAOG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;QAEF;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX,OAAO,EAAE,OAAO,CAAC;YAEjB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,IAAI,EAAE,MAAM,CAAC;YAEb,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,KAAK,CACT,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CACnB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EACD,aAAa,GACb,gBAAgB,GAChB,uBAAuB,GACvB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}