@fedpulse/sdk 1.0.0

package/dist/types/resources/intelligence.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Intelligence resource client.
+ *
+ * Wraps all /v1/intelligence endpoints:
+ *   - entityProfile     GET /v1/intelligence/entity/:uei
+ *   - marketAnalysis    GET /v1/intelligence/market/:naics
+ *   - complianceCheck   POST /v1/intelligence/compliance-check
+ */
+import type { HttpClient, ParsedResponse } from '../http.js';
+import type { EntityIntelProfile, MarketAnalysis, CompliancePackage, ComplianceCheckRequestParams } from '../types/intelligence.js';
+export declare class IntelligenceResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Get a comprehensive 360° intelligence profile for a vendor.
+     *
+     * Aggregates: contract history, agency relationships, certifications,
+     * exclusion status, and risk indicators into a single response.
+     *
+     * @param uei  Unique Entity Identifier (12-char alphanumeric).
+     * @throws {NotFoundError} If the entity does not exist in SAM.gov.
+     *
+     * @example
+     * ```ts
+     * const profile = await client.intelligence.entityProfile('ABCDEF123456');
+     * console.log('Contract count:', profile.data.contractCount);
+     * console.log('Risk:', profile.data.riskLevel);
+     * ```
+     */
+    entityProfile(uei: string): Promise<ParsedResponse<EntityIntelProfile>>;
+    /**
+     * Get a market analysis for a specific NAICS code.
+     *
+     * Returns: top awardees, top agencies, set-aside breakdown, active solicitations,
+     * total market size, and recent award trends.
+     *
+     * @param naics  2–6 digit NAICS code (more digits = more specific market segment).
+     *
+     * @example
+     * ```ts
+     * const market = await client.intelligence.marketAnalysis('541512');
+     * console.log('Market size (cents):', market.data.totalMarketSize);
+     * console.log('Top awardee:', market.data.topAwardees[0]?.name);
+     * ```
+     */
+    marketAnalysis(naics: string): Promise<ParsedResponse<MarketAnalysis>>;
+    /**
+     * Perform a full compliance check for a vendor.
+     *
+     * Returns: exclusion status, SAM.gov registration status, risk score,
+     * and risk indicators in one API call.
+     *
+     * @param params  Object containing the UEI to check.
+     * @throws {NotFoundError} If the entity does not exist in SAM.gov.
+     *
+     * @example
+     * ```ts
+     * const compliance = await client.intelligence.complianceCheck({ uei: 'ABCDEF123456' });
+     * if (compliance.data.excluded || compliance.data.riskLevel === 'high') {
+     *   console.warn('Do not contract with this vendor.');
+     * }
+     * ```
+     */
+    complianceCheck(params: ComplianceCheckRequestParams): Promise<ParsedResponse<CompliancePackage>>;
+}
+//# sourceMappingURL=intelligence.d.ts.map

package/dist/types/resources/intelligence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intelligence.d.ts","sourceRoot":"","sources":["../../../src/resources/intelligence.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,4BAA4B,EAC7B,MAAM,0BAA0B,CAAC;AAElC,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,IAAI,EAAE,UAAU;IAI5B;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAY7E;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAY5E;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CACnB,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;CAW9C"}

package/dist/types/resources/opportunities.d.cts

@@ -0,0 +1,116 @@
+/**
+ * Opportunities resource client.
+ *
+ * Wraps all /v1/opportunities endpoints:
+ *   - search (list)        GET /v1/opportunities
+ *   - stats                GET /v1/opportunities/stats
+ *   - get                  GET /v1/opportunities/:noticeId
+ *   - createExport         POST /v1/opportunities/export
+ *   - getExport            GET /v1/opportunities/export/:exportId
+ *   - downloadExport       GET /v1/opportunities/export/:exportId/download
+ *   - paginate (generator) auto-paginates over the search endpoint
+ */
+import type { HttpClient, ParsedResponse } from '../http.cjs';
+import type { Opportunity, OpportunitiesStats, ListOpportunitiesParams, GetOpportunitiesStatsParams, CreateExportParams, ExportJob } from '../types/opportunities.cjs';
+export declare class OpportunitiesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Search and filter federal contract opportunities.
+     *
+     * @param params  Filter and pagination parameters.
+     * @returns Paginated list of opportunities.
+     *
+     * @example
+     * ```ts
+     * const result = await client.opportunities.list({
+     *   q: 'cybersecurity',
+     *   naics: '541512',
+     *   postedAfter: '2025-01-01',
+     *   limit: 50,
+     * });
+     * console.log(result.data[0].title);
+     * ```
+     */
+    list(params?: ListOpportunitiesParams): Promise<ParsedResponse<Opportunity[]>>;
+    /**
+     * Get a single opportunity by its SAM.gov notice ID.
+     *
+     * @param noticeId  The unique SAM.gov notice identifier.
+     * @throws {NotFoundError} If the opportunity does not exist.
+     */
+    get(noticeId: string): Promise<ParsedResponse<Opportunity>>;
+    /**
+     * Get aggregated statistics for opportunities.
+     *
+     * @param params  Grouping and filter parameters.
+     *
+     * @example
+     * ```ts
+     * const stats = await client.opportunities.stats({ groupBy: 'naics', limit: 10 });
+     * ```
+     */
+    stats(params?: GetOpportunitiesStatsParams): Promise<ParsedResponse<OpportunitiesStats>>;
+    /**
+     * Create a background export job for opportunities.
+     *
+     * Requires: Developer plan (CSV only) or Professional/Enterprise plan (all formats).
+     * Requires: `export` API key scope.
+     *
+     * @param params  Export parameters (format + same filters as `list`).
+     * @returns Export job metadata.
+     *
+     * @example
+     * ```ts
+     * const job = await client.opportunities.createExport({ format: 'csv', agency: 'NASA' });
+     * // Poll getExport() until job.data.status === 'done', then call downloadExport().
+     * ```
+     */
+    createExport(params: CreateExportParams): Promise<ParsedResponse<ExportJob>>;
+    /**
+     * Get the status of an export job.
+     *
+     * @param exportId  UUID of the export job.
+     * @throws {NotFoundError} If the export job does not exist or belongs to another user.
+     */
+    getExport(exportId: string): Promise<ParsedResponse<ExportJob>>;
+    /**
+     * Download the output file of a completed export job.
+     *
+     * Returns the raw `Response` object so callers can stream or save the body.
+     * The response body will be CSV or NDJSON depending on the export format.
+     *
+     * @param exportId  UUID of a **completed** export job.
+     * @returns Raw fetch `Response` with the file body.
+     * @throws {PermissionError} If the export is not complete.
+     * @throws {NotFoundError}   If the export does not exist.
+     *
+     * @example
+     * ```ts
+     * const response = await client.opportunities.downloadExport(exportId);
+     * const csv = await response.text();
+     * ```
+     */
+    downloadExport(exportId: string): Promise<Response>;
+    /**
+     * Async generator that automatically paginates over all matching opportunities.
+     *
+     * Uses cursor-based pagination when available, falling back to offset.
+     * Yields one page of results at a time.
+     *
+     * @param params  Same filter parameters as `list()`. Do not pass `page` or `cursor`.
+     *
+     * @example
+     * ```ts
+     * for await (const page of client.opportunities.paginate({ naics: '541512' })) {
+     *   for (const opp of page.data) {
+     *     console.log(opp.title);
+     *   }
+     * }
+     * ```
+     */
+    paginate(params: Omit<ListOpportunitiesParams, 'page' | 'cursor'> & {
+        limit?: number;
+    }): AsyncGenerator<ParsedResponse<Opportunity[]>>;
+}
+//# sourceMappingURL=opportunities.d.ts.map

package/dist/types/resources/opportunities.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Opportunities resource client.
+ *
+ * Wraps all /v1/opportunities endpoints:
+ *   - search (list)        GET /v1/opportunities
+ *   - stats                GET /v1/opportunities/stats
+ *   - get                  GET /v1/opportunities/:noticeId
+ *   - createExport         POST /v1/opportunities/export
+ *   - getExport            GET /v1/opportunities/export/:exportId
+ *   - downloadExport       GET /v1/opportunities/export/:exportId/download
+ *   - paginate (generator) auto-paginates over the search endpoint
+ */
+import type { HttpClient, ParsedResponse } from '../http.js';
+import type { Opportunity, OpportunitiesStats, ListOpportunitiesParams, GetOpportunitiesStatsParams, CreateExportParams, ExportJob } from '../types/opportunities.js';
+export declare class OpportunitiesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Search and filter federal contract opportunities.
+     *
+     * @param params  Filter and pagination parameters.
+     * @returns Paginated list of opportunities.
+     *
+     * @example
+     * ```ts
+     * const result = await client.opportunities.list({
+     *   q: 'cybersecurity',
+     *   naics: '541512',
+     *   postedAfter: '2025-01-01',
+     *   limit: 50,
+     * });
+     * console.log(result.data[0].title);
+     * ```
+     */
+    list(params?: ListOpportunitiesParams): Promise<ParsedResponse<Opportunity[]>>;
+    /**
+     * Get a single opportunity by its SAM.gov notice ID.
+     *
+     * @param noticeId  The unique SAM.gov notice identifier.
+     * @throws {NotFoundError} If the opportunity does not exist.
+     */
+    get(noticeId: string): Promise<ParsedResponse<Opportunity>>;
+    /**
+     * Get aggregated statistics for opportunities.
+     *
+     * @param params  Grouping and filter parameters.
+     *
+     * @example
+     * ```ts
+     * const stats = await client.opportunities.stats({ groupBy: 'naics', limit: 10 });
+     * ```
+     */
+    stats(params?: GetOpportunitiesStatsParams): Promise<ParsedResponse<OpportunitiesStats>>;
+    /**
+     * Create a background export job for opportunities.
+     *
+     * Requires: Developer plan (CSV only) or Professional/Enterprise plan (all formats).
+     * Requires: `export` API key scope.
+     *
+     * @param params  Export parameters (format + same filters as `list`).
+     * @returns Export job metadata.
+     *
+     * @example
+     * ```ts
+     * const job = await client.opportunities.createExport({ format: 'csv', agency: 'NASA' });
+     * // Poll getExport() until job.data.status === 'done', then call downloadExport().
+     * ```
+     */
+    createExport(params: CreateExportParams): Promise<ParsedResponse<ExportJob>>;
+    /**
+     * Get the status of an export job.
+     *
+     * @param exportId  UUID of the export job.
+     * @throws {NotFoundError} If the export job does not exist or belongs to another user.
+     */
+    getExport(exportId: string): Promise<ParsedResponse<ExportJob>>;
+    /**
+     * Download the output file of a completed export job.
+     *
+     * Returns the raw `Response` object so callers can stream or save the body.
+     * The response body will be CSV or NDJSON depending on the export format.
+     *
+     * @param exportId  UUID of a **completed** export job.
+     * @returns Raw fetch `Response` with the file body.
+     * @throws {PermissionError} If the export is not complete.
+     * @throws {NotFoundError}   If the export does not exist.
+     *
+     * @example
+     * ```ts
+     * const response = await client.opportunities.downloadExport(exportId);
+     * const csv = await response.text();
+     * ```
+     */
+    downloadExport(exportId: string): Promise<Response>;
+    /**
+     * Async generator that automatically paginates over all matching opportunities.
+     *
+     * Uses cursor-based pagination when available, falling back to offset.
+     * Yields one page of results at a time.
+     *
+     * @param params  Same filter parameters as `list()`. Do not pass `page` or `cursor`.
+     *
+     * @example
+     * ```ts
+     * for await (const page of client.opportunities.paginate({ naics: '541512' })) {
+     *   for (const opp of page.data) {
+     *     console.log(opp.title);
+     *   }
+     * }
+     * ```
+     */
+    paginate(params: Omit<ListOpportunitiesParams, 'page' | 'cursor'> & {
+        limit?: number;
+    }): AsyncGenerator<ParsedResponse<Opportunity[]>>;
+}
+//# sourceMappingURL=opportunities.d.ts.map

package/dist/types/resources/opportunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opportunities.d.ts","sourceRoot":"","sources":["../../../src/resources/opportunities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,kBAAkB,EAClB,SAAS,EACV,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,IAAI,EAAE,UAAU;IAI5B;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CACR,MAAM,GAAE,uBAA4B,GACnC,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;IAOzC;;;;;OAKG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IASjE;;;;;;;;;OASG;IACG,KAAK,CACT,MAAM,GAAE,2BAAgC,GACvC,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAO9C;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAIrC;;;;;OAKG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAWrE;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IASzD;;;;;;;;;;;;;;;;OAgBG;IACI,QAAQ,CACb,MAAM,EAAE,IAAI,CAAC,uBAAuB,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5E,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;CA+BjD"}

package/dist/types/resources/webhooks.d.cts

@@ -0,0 +1,180 @@
+/**
+ * Webhooks resource client.
+ *
+ * Wraps all /v1/webhooks endpoints:
+ *   - create           POST   /v1/webhooks
+ *   - list             GET    /v1/webhooks
+ *   - get              GET    /v1/webhooks/:id
+ *   - update           PATCH  /v1/webhooks/:id
+ *   - delete           DELETE /v1/webhooks/:id
+ *   - test             POST   /v1/webhooks/:id/test
+ *   - resume           POST   /v1/webhooks/:id/resume
+ *   - listDeliveries   GET    /v1/webhooks/:id/deliveries
+ *   - getDelivery      GET    /v1/webhooks/:id/deliveries/:deliveryId
+ *   - deliveryPages    async generator over deliveries
+ *
+ * Requires: `webhook` API key scope for all operations.
+ */
+import type { HttpClient, ParsedResponse } from '../http.cjs';
+import type { Webhook, WebhookDelivery, CreateWebhookParams, UpdateWebhookParams, CreateWebhookResult, RotateSecretResult, ListDeliveriesParams } from '../types/webhooks.cjs';
+export declare class WebhooksResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Create a new webhook subscription.
+     *
+     * **Important:** The raw signing secret is returned once in the response
+     * (`result.data.secret`) and can never be retrieved again. Store it securely
+     * and use it to verify incoming deliveries with `FedPulse.verifyWebhook()`.
+     *
+     * @param params  Webhook creation parameters.
+     * @throws {PermissionError} If the API key lacks the `webhook` scope.
+     * @throws {PermissionError} If the plan limit for webhooks has been reached.
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.create({
+     *   url: 'https://my-app.example.com/webhooks/fedpulse',
+     *   events: ['opportunity.new', 'opportunity.modified'],
+     *   filters: { naics: ['541512'], state: 'VA' },
+     * });
+     * const signingSecret = result.data.secret; // Store this securely!
+     * ```
+     */
+    create(params: CreateWebhookParams): Promise<ParsedResponse<CreateWebhookResult>>;
+    /**
+     * List all webhook subscriptions for the authenticated user.
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * for (const wh of webhooks.data) {
+     *   console.log(wh.id, wh.url, wh.isActive);
+     * }
+     * ```
+     */
+    list(): Promise<ParsedResponse<Webhook[]>>;
+    /**
+     * Get a single webhook subscription.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist or belongs to another user.
+     *
+     * @example
+     * ```ts
+     * const wh = await client.webhooks.get('wh-uuid');
+     * console.log(wh.data.isActive, wh.data.consecutiveFailures);
+     * ```
+     */
+    get(id: string): Promise<ParsedResponse<Webhook>>;
+    /**
+     * Update a webhook subscription.
+     *
+     * Pass `rotateSecret: true` to generate a new signing secret.
+     * The new secret will be returned in the response.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Fields to update. At least one non-`rotateSecret` field required.
+     * @throws {NotFoundError} If the webhook does not exist.
+     * @throws {ValidationError} If no update fields are provided.
+     *
+     * @example
+     * ```ts
+     * const updated = await client.webhooks.update('wh-uuid', {
+     *   url: 'https://new-endpoint.example.com/webhooks',
+     *   events: ['opportunity.new'],
+     * });
+     * ```
+     */
+    update(id: string, params: UpdateWebhookParams): Promise<ParsedResponse<Webhook | RotateSecretResult>>;
+    /**
+     * Delete a webhook subscription.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.delete('wh-uuid');
+     * ```
+     */
+    delete(id: string): Promise<ParsedResponse<null>>;
+    /**
+     * Send a test event to a webhook endpoint (synchronous delivery).
+     *
+     * Unlike real deliveries, test events are sent immediately (no queue) and
+     * do not count against the circuit-breaker failure counter.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.test('wh-uuid');
+     * console.log('Test delivery status:', result.data);
+     * ```
+     */
+    test(id: string): Promise<ParsedResponse<unknown>>;
+    /**
+     * Resume a paused webhook (clear the circuit-breaker).
+     *
+     * Webhooks are auto-paused after 5 consecutive delivery failures.
+     * Use this to re-enable delivery after fixing the endpoint.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.resume('wh-uuid');
+     * ```
+     */
+    resume(id: string): Promise<ParsedResponse<Webhook>>;
+    /**
+     * Get paginated delivery history for a webhook.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Filter and pagination parameters.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * const deliveries = await client.webhooks.listDeliveries('wh-uuid', {
+     *   status: 'failed',
+     *   limit: 50,
+     * });
+     * ```
+     */
+    listDeliveries(id: string, params?: ListDeliveriesParams): Promise<ParsedResponse<WebhookDelivery[]>>;
+    /**
+     * Get the full detail of a single webhook delivery, including the payload.
+     *
+     * @param id          Webhook UUID.
+     * @param deliveryId  Delivery UUID.
+     * @throws {NotFoundError} If the webhook or delivery does not exist.
+     *
+     * @example
+     * ```ts
+     * const delivery = await client.webhooks.getDelivery('wh-uuid', 'del-uuid');
+     * console.log('Payload:', delivery.data.payload);
+     * ```
+     */
+    getDelivery(id: string, deliveryId: string): Promise<ParsedResponse<WebhookDelivery>>;
+    /**
+     * Async generator that automatically paginates through delivery history.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Same filter parameters as `listDeliveries()`. Do not pass `page`.
+     *
+     * @example
+     * ```ts
+     * for await (const page of client.webhooks.deliveryPages('wh-uuid', { status: 'failed' })) {
+     *   for (const delivery of page.data) {
+     *     console.log(delivery.id, delivery.status, delivery.httpStatus);
+     *   }
+     * }
+     * ```
+     */
+    deliveryPages(id: string, params?: Omit<ListDeliveriesParams, 'page'>): AsyncGenerator<ParsedResponse<WebhookDelivery[]>>;
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/types/resources/webhooks.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Webhooks resource client.
+ *
+ * Wraps all /v1/webhooks endpoints:
+ *   - create           POST   /v1/webhooks
+ *   - list             GET    /v1/webhooks
+ *   - get              GET    /v1/webhooks/:id
+ *   - update           PATCH  /v1/webhooks/:id
+ *   - delete           DELETE /v1/webhooks/:id
+ *   - test             POST   /v1/webhooks/:id/test
+ *   - resume           POST   /v1/webhooks/:id/resume
+ *   - listDeliveries   GET    /v1/webhooks/:id/deliveries
+ *   - getDelivery      GET    /v1/webhooks/:id/deliveries/:deliveryId
+ *   - deliveryPages    async generator over deliveries
+ *
+ * Requires: `webhook` API key scope for all operations.
+ */
+import type { HttpClient, ParsedResponse } from '../http.js';
+import type { Webhook, WebhookDelivery, CreateWebhookParams, UpdateWebhookParams, CreateWebhookResult, RotateSecretResult, ListDeliveriesParams } from '../types/webhooks.js';
+export declare class WebhooksResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Create a new webhook subscription.
+     *
+     * **Important:** The raw signing secret is returned once in the response
+     * (`result.data.secret`) and can never be retrieved again. Store it securely
+     * and use it to verify incoming deliveries with `FedPulse.verifyWebhook()`.
+     *
+     * @param params  Webhook creation parameters.
+     * @throws {PermissionError} If the API key lacks the `webhook` scope.
+     * @throws {PermissionError} If the plan limit for webhooks has been reached.
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.create({
+     *   url: 'https://my-app.example.com/webhooks/fedpulse',
+     *   events: ['opportunity.new', 'opportunity.modified'],
+     *   filters: { naics: ['541512'], state: 'VA' },
+     * });
+     * const signingSecret = result.data.secret; // Store this securely!
+     * ```
+     */
+    create(params: CreateWebhookParams): Promise<ParsedResponse<CreateWebhookResult>>;
+    /**
+     * List all webhook subscriptions for the authenticated user.
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * for (const wh of webhooks.data) {
+     *   console.log(wh.id, wh.url, wh.isActive);
+     * }
+     * ```
+     */
+    list(): Promise<ParsedResponse<Webhook[]>>;
+    /**
+     * Get a single webhook subscription.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist or belongs to another user.
+     *
+     * @example
+     * ```ts
+     * const wh = await client.webhooks.get('wh-uuid');
+     * console.log(wh.data.isActive, wh.data.consecutiveFailures);
+     * ```
+     */
+    get(id: string): Promise<ParsedResponse<Webhook>>;
+    /**
+     * Update a webhook subscription.
+     *
+     * Pass `rotateSecret: true` to generate a new signing secret.
+     * The new secret will be returned in the response.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Fields to update. At least one non-`rotateSecret` field required.
+     * @throws {NotFoundError} If the webhook does not exist.
+     * @throws {ValidationError} If no update fields are provided.
+     *
+     * @example
+     * ```ts
+     * const updated = await client.webhooks.update('wh-uuid', {
+     *   url: 'https://new-endpoint.example.com/webhooks',
+     *   events: ['opportunity.new'],
+     * });
+     * ```
+     */
+    update(id: string, params: UpdateWebhookParams): Promise<ParsedResponse<Webhook | RotateSecretResult>>;
+    /**
+     * Delete a webhook subscription.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.delete('wh-uuid');
+     * ```
+     */
+    delete(id: string): Promise<ParsedResponse<null>>;
+    /**
+     * Send a test event to a webhook endpoint (synchronous delivery).
+     *
+     * Unlike real deliveries, test events are sent immediately (no queue) and
+     * do not count against the circuit-breaker failure counter.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * const result = await client.webhooks.test('wh-uuid');
+     * console.log('Test delivery status:', result.data);
+     * ```
+     */
+    test(id: string): Promise<ParsedResponse<unknown>>;
+    /**
+     * Resume a paused webhook (clear the circuit-breaker).
+     *
+     * Webhooks are auto-paused after 5 consecutive delivery failures.
+     * Use this to re-enable delivery after fixing the endpoint.
+     *
+     * @param id  Webhook UUID.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.resume('wh-uuid');
+     * ```
+     */
+    resume(id: string): Promise<ParsedResponse<Webhook>>;
+    /**
+     * Get paginated delivery history for a webhook.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Filter and pagination parameters.
+     * @throws {NotFoundError} If the webhook does not exist.
+     *
+     * @example
+     * ```ts
+     * const deliveries = await client.webhooks.listDeliveries('wh-uuid', {
+     *   status: 'failed',
+     *   limit: 50,
+     * });
+     * ```
+     */
+    listDeliveries(id: string, params?: ListDeliveriesParams): Promise<ParsedResponse<WebhookDelivery[]>>;
+    /**
+     * Get the full detail of a single webhook delivery, including the payload.
+     *
+     * @param id          Webhook UUID.
+     * @param deliveryId  Delivery UUID.
+     * @throws {NotFoundError} If the webhook or delivery does not exist.
+     *
+     * @example
+     * ```ts
+     * const delivery = await client.webhooks.getDelivery('wh-uuid', 'del-uuid');
+     * console.log('Payload:', delivery.data.payload);
+     * ```
+     */
+    getDelivery(id: string, deliveryId: string): Promise<ParsedResponse<WebhookDelivery>>;
+    /**
+     * Async generator that automatically paginates through delivery history.
+     *
+     * @param id      Webhook UUID.
+     * @param params  Same filter parameters as `listDeliveries()`. Do not pass `page`.
+     *
+     * @example
+     * ```ts
+     * for await (const page of client.webhooks.deliveryPages('wh-uuid', { status: 'failed' })) {
+     *   for (const delivery of page.data) {
+     *     console.log(delivery.id, delivery.status, delivery.httpStatus);
+     *   }
+     * }
+     * ```
+     */
+    deliveryPages(id: string, params?: Omit<ListDeliveriesParams, 'page'>): AsyncGenerator<ParsedResponse<WebhookDelivery[]>>;
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/types/resources/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../../src/resources/webhooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,KAAK,EACV,OAAO,EACP,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,IAAI,EAAE,UAAU;IAI5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAK/C;;;;;;;;;;OAUG;IACG,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;IAIhD;;;;;;;;;;;OAWG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAKvD;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,cAAc,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;IAWxD;;;;;;;;;;OAUG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAKvD;;;;;;;;;;;;;;OAcG;IACG,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAKxD;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAK1D;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC;IAS7C;;;;;;;;;;;;OAYG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAU3C;;;;;;;;;;;;;;OAcG;IACI,aAAa,CAClB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAM,GAC9C,cAAc,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC;CAoBrD"}