@fedpulse/sdk 1.0.0

package/dist/types/types/analytics.d.cts

@@ -0,0 +1,85 @@
+/**
+ * Types for the Analytics domain (/v1/analytics).
+ */
+export type AnalyticsRange = '24h' | '7d' | '30d' | '90d';
+export interface AnalyticsSummary {
+    requestsToday: number;
+    requestsThisMonth: number;
+    requestsInRange: number;
+    errors4xx: number;
+    errors5xx: number;
+    rateLimitEvents: number;
+    /** 4xx error rate as a fraction (0–1). */
+    errorRate4xx: number;
+    /** 5xx error rate as a fraction (0–1). */
+    errorRate5xx: number;
+}
+export interface AnalyticsChartDay {
+    /** ISO date string (YYYY-MM-DD). */
+    date: string;
+    total: number;
+    success: number;
+    /** 4xx count. */
+    e4xx: number;
+    /** 5xx count. */
+    e5xx: number;
+}
+export interface AnalyticsChart {
+    days: AnalyticsChartDay[];
+}
+export interface AnalyticsEndpoint {
+    endpoint: string;
+    method?: string | null;
+    requestCount: number;
+    /** P95 response time in milliseconds. */
+    p95LatencyMs: number;
+    errorRate: number;
+}
+export interface AnalyticsEndpoints {
+    byVolume: AnalyticsEndpoint[];
+    byLatency: AnalyticsEndpoint[];
+}
+export type LogStatusFilter = 'all' | '2xx' | '4xx' | '5xx';
+export interface AnalyticsLogEntry {
+    requestId: string;
+    method: string;
+    endpoint: string;
+    statusCode: number;
+    latencyMs?: number | null;
+    apiKeyId?: string | null;
+    createdAt: string;
+}
+export interface AnalyticsLogs {
+    items: AnalyticsLogEntry[];
+    nextCursor: string | null;
+    hasNextPage: boolean;
+}
+export interface AnalyticsSummaryParams {
+    /** Scope to a specific API key UUID. */
+    keyId?: string;
+    /** Time window. Default: '30d'. */
+    range?: AnalyticsRange;
+}
+export interface AnalyticsChartParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+}
+export interface AnalyticsEndpointsParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+}
+export interface AnalyticsLogsParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+    /** Maximum number of log entries (1–1000). Default: 100. */
+    limit?: number;
+    /** Pagination cursor. */
+    cursor?: string;
+    /** Filter by status class. Default: 'all'. */
+    status?: LogStatusFilter;
+    /** Filter by exact endpoint pattern. */
+    endpoint?: string;
+    /** Partial match on request ID. */
+    requestId?: string;
+}
+//# sourceMappingURL=analytics.d.ts.map

package/dist/types/types/analytics.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Types for the Analytics domain (/v1/analytics).
+ */
+export type AnalyticsRange = '24h' | '7d' | '30d' | '90d';
+export interface AnalyticsSummary {
+    requestsToday: number;
+    requestsThisMonth: number;
+    requestsInRange: number;
+    errors4xx: number;
+    errors5xx: number;
+    rateLimitEvents: number;
+    /** 4xx error rate as a fraction (0–1). */
+    errorRate4xx: number;
+    /** 5xx error rate as a fraction (0–1). */
+    errorRate5xx: number;
+}
+export interface AnalyticsChartDay {
+    /** ISO date string (YYYY-MM-DD). */
+    date: string;
+    total: number;
+    success: number;
+    /** 4xx count. */
+    e4xx: number;
+    /** 5xx count. */
+    e5xx: number;
+}
+export interface AnalyticsChart {
+    days: AnalyticsChartDay[];
+}
+export interface AnalyticsEndpoint {
+    endpoint: string;
+    method?: string | null;
+    requestCount: number;
+    /** P95 response time in milliseconds. */
+    p95LatencyMs: number;
+    errorRate: number;
+}
+export interface AnalyticsEndpoints {
+    byVolume: AnalyticsEndpoint[];
+    byLatency: AnalyticsEndpoint[];
+}
+export type LogStatusFilter = 'all' | '2xx' | '4xx' | '5xx';
+export interface AnalyticsLogEntry {
+    requestId: string;
+    method: string;
+    endpoint: string;
+    statusCode: number;
+    latencyMs?: number | null;
+    apiKeyId?: string | null;
+    createdAt: string;
+}
+export interface AnalyticsLogs {
+    items: AnalyticsLogEntry[];
+    nextCursor: string | null;
+    hasNextPage: boolean;
+}
+export interface AnalyticsSummaryParams {
+    /** Scope to a specific API key UUID. */
+    keyId?: string;
+    /** Time window. Default: '30d'. */
+    range?: AnalyticsRange;
+}
+export interface AnalyticsChartParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+}
+export interface AnalyticsEndpointsParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+}
+export interface AnalyticsLogsParams {
+    keyId?: string;
+    range?: AnalyticsRange;
+    /** Maximum number of log entries (1–1000). Default: 100. */
+    limit?: number;
+    /** Pagination cursor. */
+    cursor?: string;
+    /** Filter by status class. Default: 'all'. */
+    status?: LogStatusFilter;
+    /** Filter by exact endpoint pattern. */
+    endpoint?: string;
+    /** Partial match on request ID. */
+    requestId?: string;
+}
+//# sourceMappingURL=analytics.d.ts.map

package/dist/types/types/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/types/analytics.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC;AAI1D,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,iBAAiB,EAAE,CAAC;CAC3B;AAID,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAID,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAE5D,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;CACtB;AAID,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/types/assistance.d.cts

@@ -0,0 +1,55 @@
+/**
+ * Types for the Assistance Listings domain (/v1/assistance).
+ */
+import type { PaginationParams } from './common.cjs';
+export interface AssistanceListing {
+    /** CFDA program number (XX.XXX format). */
+    programNumber: string;
+    programTitle: string;
+    federalAgency?: string | null;
+    programType?: string | null;
+    objectives?: string | null;
+    typesOfAssistance?: string[] | null;
+    eligibilityApplicants?: string | null;
+    eligibilityBeneficiaries?: string | null;
+    applicationProcedure?: string | null;
+    postAwardRequirements?: string | null;
+    fundingRangeDescription?: string | null;
+    averageAward?: number | null;
+    /** Number of awards made in the most recent fiscal year. */
+    awardsCount?: number | null;
+    regulations?: string | null;
+    contactName?: string | null;
+    contactPhone?: string | null;
+    contactEmail?: string | null;
+    contactAddress?: string | null;
+    websiteAddress?: string | null;
+    isActive?: boolean | null;
+    fiscalYear?: number | null;
+    lastUpdated?: string | null;
+}
+export interface AssistanceStats {
+    total: number;
+    active: number;
+    byAgency: Array<{
+        agency: string;
+        count: number;
+    }>;
+    byType: Array<{
+        type: string;
+        count: number;
+    }>;
+}
+export interface ListAssistanceParams extends PaginationParams {
+    /** Full-text search query. */
+    q?: string;
+    /** Filter by federal agency name or code. */
+    agency?: string;
+    /** Filter by assistance type. */
+    type?: string;
+}
+export interface GetAssistanceStatsParams {
+    /** Filter by federal agency. */
+    agency?: string;
+}
+//# sourceMappingURL=assistance.d.ts.map

package/dist/types/types/assistance.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Types for the Assistance Listings domain (/v1/assistance).
+ */
+import type { PaginationParams } from './common.js';
+export interface AssistanceListing {
+    /** CFDA program number (XX.XXX format). */
+    programNumber: string;
+    programTitle: string;
+    federalAgency?: string | null;
+    programType?: string | null;
+    objectives?: string | null;
+    typesOfAssistance?: string[] | null;
+    eligibilityApplicants?: string | null;
+    eligibilityBeneficiaries?: string | null;
+    applicationProcedure?: string | null;
+    postAwardRequirements?: string | null;
+    fundingRangeDescription?: string | null;
+    averageAward?: number | null;
+    /** Number of awards made in the most recent fiscal year. */
+    awardsCount?: number | null;
+    regulations?: string | null;
+    contactName?: string | null;
+    contactPhone?: string | null;
+    contactEmail?: string | null;
+    contactAddress?: string | null;
+    websiteAddress?: string | null;
+    isActive?: boolean | null;
+    fiscalYear?: number | null;
+    lastUpdated?: string | null;
+}
+export interface AssistanceStats {
+    total: number;
+    active: number;
+    byAgency: Array<{
+        agency: string;
+        count: number;
+    }>;
+    byType: Array<{
+        type: string;
+        count: number;
+    }>;
+}
+export interface ListAssistanceParams extends PaginationParams {
+    /** Full-text search query. */
+    q?: string;
+    /** Filter by federal agency name or code. */
+    agency?: string;
+    /** Filter by assistance type. */
+    type?: string;
+}
+export interface GetAssistanceStatsParams {
+    /** Filter by federal agency. */
+    agency?: string;
+}
+//# sourceMappingURL=assistance.d.ts.map

package/dist/types/types/assistance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assistance.d.ts","sourceRoot":"","sources":["../../../src/types/assistance.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAChD;AAID,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,8BAA8B;IAC9B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/types/common.d.cts

@@ -0,0 +1,58 @@
+/**
+ * Common types shared across all FedPulse API domains.
+ */
+export interface RateLimitInfo {
+    /** Maximum requests allowed in the current window. */
+    limit: number;
+    /** Requests remaining in the current window. */
+    remaining: number;
+    /** Unix epoch seconds when the window resets. */
+    reset: number;
+}
+export interface OffsetPagination {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+export interface CursorPagination {
+    nextCursor: string | null;
+    hasNextPage: boolean;
+    limit: number;
+}
+export type Pagination = OffsetPagination | CursorPagination | null;
+export interface ResponseMeta {
+    requestId: string;
+    /** Whether the result was served from cache. */
+    cached?: boolean;
+    [key: string]: unknown;
+}
+export interface ApiResponse<T> {
+    success: true;
+    data: T;
+    pagination: Pagination;
+    meta: ResponseMeta;
+    rateLimit: RateLimitInfo | null;
+}
+export interface PaginationParams {
+    /** Page number (1–1000). Default: 1. */
+    page?: number;
+    /** Results per page (1–100). Default: 25. */
+    limit?: number;
+    /** Opaque cursor for cursor-based pagination. */
+    cursor?: string;
+}
+export interface SortParams {
+    sort?: string;
+    dir?: 'asc' | 'desc';
+}
+export interface FieldsParam {
+    /**
+     * Comma-separated list of fields to include in the response.
+     * Reduces payload size when only a subset of fields is needed.
+     */
+    fields?: string;
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/types/types/common.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Common types shared across all FedPulse API domains.
+ */
+export interface RateLimitInfo {
+    /** Maximum requests allowed in the current window. */
+    limit: number;
+    /** Requests remaining in the current window. */
+    remaining: number;
+    /** Unix epoch seconds when the window resets. */
+    reset: number;
+}
+export interface OffsetPagination {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+export interface CursorPagination {
+    nextCursor: string | null;
+    hasNextPage: boolean;
+    limit: number;
+}
+export type Pagination = OffsetPagination | CursorPagination | null;
+export interface ResponseMeta {
+    requestId: string;
+    /** Whether the result was served from cache. */
+    cached?: boolean;
+    [key: string]: unknown;
+}
+export interface ApiResponse<T> {
+    success: true;
+    data: T;
+    pagination: Pagination;
+    meta: ResponseMeta;
+    rateLimit: RateLimitInfo | null;
+}
+export interface PaginationParams {
+    /** Page number (1–1000). Default: 1. */
+    page?: number;
+    /** Results per page (1–100). Default: 25. */
+    limit?: number;
+    /** Opaque cursor for cursor-based pagination. */
+    cursor?: string;
+}
+export interface SortParams {
+    sort?: string;
+    dir?: 'asc' | 'desc';
+}
+export interface FieldsParam {
+    /**
+     * Comma-separated list of fields to include in the response.
+     * Reduces payload size when only a subset of fields is needed.
+     */
+    fields?: string;
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/types/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/types/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,IAAI,CAAC;AAIpE,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAID,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;IACR,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAID,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/types/entities.d.cts

@@ -0,0 +1,85 @@
+/**
+ * Types for the Entities domain (/v1/entities).
+ */
+import type { PaginationParams } from './common.cjs';
+export interface EntityAddress {
+    street?: string | null;
+    street2?: string | null;
+    city?: string | null;
+    state?: string | null;
+    zip?: string | null;
+    country?: string | null;
+}
+export interface EntityCertification {
+    type: string;
+    value?: string | null;
+    expirationDate?: string | null;
+}
+export interface EntityNaicsEntry {
+    naicsCode: string;
+    isPrimary: boolean;
+    description?: string | null;
+}
+export interface Entity {
+    uei: string;
+    cage?: string | null;
+    legalBusinessName: string;
+    dbaName?: string | null;
+    status?: string | null;
+    entityType?: string | null;
+    registrationDate?: string | null;
+    expirationDate?: string | null;
+    lastUpdated?: string | null;
+    physicalAddress?: EntityAddress | null;
+    mailingAddress?: EntityAddress | null;
+    naicsCodes?: EntityNaicsEntry[] | null;
+    primaryNaics?: string | null;
+    certifications?: EntityCertification[] | null;
+    purposeOfRegistration?: string | null;
+    organizationStructure?: string | null;
+    stateOfIncorporation?: string | null;
+    countryOfIncorporation?: string | null;
+    congressionalDistrict?: string | null;
+    submissionDate?: string | null;
+    activationDate?: string | null;
+    /** Number of open contract opportunities linked to this entity. */
+    openOpportunitiesCount?: number | null;
+    /** Total value of awarded contracts (in cents). */
+    totalAwardAmount?: number | null;
+    hasActiveExclusion?: boolean | null;
+    rawJson?: unknown;
+}
+export interface EntityStats {
+    total: number;
+    active: number;
+    byState: Array<{
+        state: string;
+        count: number;
+    }>;
+    byNaics: Array<{
+        naics: string;
+        count: number;
+    }>;
+    byCertification: Array<{
+        certification: string;
+        count: number;
+    }>;
+}
+export interface EntityExclusionCheckResult {
+    uei: string;
+    excluded: boolean;
+    /** The active exclusion record, or null if not excluded. */
+    exclusion: import('./exclusions.js').Exclusion | null;
+    checkedAt: string;
+}
+export interface ListEntitiesParams extends PaginationParams {
+    /** Search by legal business name or DBA name. */
+    q?: string;
+    /** Filter by NAICS code (2–6 digits). */
+    naics?: string;
+    /** Filter by small-business certification type (e.g. '8A', 'WOSB', 'HUBZone'). */
+    certification?: string;
+    /** Filter by US state code (2-letter). */
+    state?: string;
+}
+//# sourceMappingURL=entities.d.ts.map

package/dist/types/types/entities.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Types for the Entities domain (/v1/entities).
+ */
+import type { PaginationParams } from './common.js';
+export interface EntityAddress {
+    street?: string | null;
+    street2?: string | null;
+    city?: string | null;
+    state?: string | null;
+    zip?: string | null;
+    country?: string | null;
+}
+export interface EntityCertification {
+    type: string;
+    value?: string | null;
+    expirationDate?: string | null;
+}
+export interface EntityNaicsEntry {
+    naicsCode: string;
+    isPrimary: boolean;
+    description?: string | null;
+}
+export interface Entity {
+    uei: string;
+    cage?: string | null;
+    legalBusinessName: string;
+    dbaName?: string | null;
+    status?: string | null;
+    entityType?: string | null;
+    registrationDate?: string | null;
+    expirationDate?: string | null;
+    lastUpdated?: string | null;
+    physicalAddress?: EntityAddress | null;
+    mailingAddress?: EntityAddress | null;
+    naicsCodes?: EntityNaicsEntry[] | null;
+    primaryNaics?: string | null;
+    certifications?: EntityCertification[] | null;
+    purposeOfRegistration?: string | null;
+    organizationStructure?: string | null;
+    stateOfIncorporation?: string | null;
+    countryOfIncorporation?: string | null;
+    congressionalDistrict?: string | null;
+    submissionDate?: string | null;
+    activationDate?: string | null;
+    /** Number of open contract opportunities linked to this entity. */
+    openOpportunitiesCount?: number | null;
+    /** Total value of awarded contracts (in cents). */
+    totalAwardAmount?: number | null;
+    hasActiveExclusion?: boolean | null;
+    rawJson?: unknown;
+}
+export interface EntityStats {
+    total: number;
+    active: number;
+    byState: Array<{
+        state: string;
+        count: number;
+    }>;
+    byNaics: Array<{
+        naics: string;
+        count: number;
+    }>;
+    byCertification: Array<{
+        certification: string;
+        count: number;
+    }>;
+}
+export interface EntityExclusionCheckResult {
+    uei: string;
+    excluded: boolean;
+    /** The active exclusion record, or null if not excluded. */
+    exclusion: import('./exclusions.js').Exclusion | null;
+    checkedAt: string;
+}
+export interface ListEntitiesParams extends PaginationParams {
+    /** Search by legal business name or DBA name. */
+    q?: string;
+    /** Filter by NAICS code (2–6 digits). */
+    naics?: string;
+    /** Filter by small-business certification type (e.g. '8A', 'WOSB', 'HUBZone'). */
+    certification?: string;
+    /** Filter by US state code (2-letter). */
+    state?: string;
+}
+//# sourceMappingURL=entities.d.ts.map

package/dist/types/types/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/types/entities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC,cAAc,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACtC,UAAU,CAAC,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,CAAC,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAC9C,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mEAAmE;IACnE,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjD,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjD,eAAe,EAAE,KAAK,CAAC;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClE;AAID,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,4DAA4D;IAC5D,SAAS,EAAE,OAAO,iBAAiB,EAAE,SAAS,GAAG,IAAI,CAAC;IACtD,SAAS,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,iDAAiD;IACjD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kFAAkF;IAClF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/types/types/exclusions.d.cts

@@ -0,0 +1,81 @@
+/**
+ * Types for the Exclusions domain (/v1/exclusions).
+ */
+import type { PaginationParams } from './common.cjs';
+export interface Exclusion {
+    exclusionId: string;
+    uei?: string | null;
+    cage?: string | null;
+    name?: string | null;
+    legalName?: string | null;
+    exclusionType?: string | null;
+    exclusionProgram?: string | null;
+    exclusionAction?: string | null;
+    agencyCode?: string | null;
+    agency?: string | null;
+    effectiveDate?: string | null;
+    expirationDate?: string | null;
+    terminationDate?: string | null;
+    terminatedBy?: string | null;
+    address?: {
+        street?: string | null;
+        city?: string | null;
+        state?: string | null;
+        zip?: string | null;
+        country?: string | null;
+    } | null;
+    ctCode?: string | null;
+    additionalRemarks?: string | null;
+    crossReferenceList?: string[] | null;
+    rawJson?: unknown;
+}
+export interface ComplianceCheckEntity {
+    /** Unique Entity Identifier (12-char alphanumeric). */
+    uei?: string;
+    /** CAGE code. */
+    cage?: string;
+    /** Legal entity name (enables fuzzy matching). */
+    name?: string;
+}
+export interface ComplianceCheckResult {
+    input: ComplianceCheckEntity;
+    excluded: boolean;
+    /** Confidence level when matched by name (0–1). Present when fuzzy match used. */
+    matchConfidence?: number | null;
+    /** The matched exclusion record, or null if not excluded / no match. */
+    exclusion: Exclusion | null;
+    /** Human-readable explanation of the result. */
+    message: string;
+}
+export interface ExclusionsStats {
+    total: number;
+    active: number;
+    expired: number;
+    byType: Array<{
+        type: string;
+        count: number;
+    }>;
+    byAgency: Array<{
+        agency: string;
+        count: number;
+    }>;
+}
+export interface ListExclusionsParams extends PaginationParams {
+    /** Search by entity name or legal name. */
+    q?: string;
+    /** Filter by Unique Entity Identifier. */
+    uei?: string;
+    /** Filter by CAGE code. */
+    cage?: string;
+    /** Filter by excluding agency code or name. */
+    agency?: string;
+    /** Only return active exclusions (not yet terminated/expired). */
+    activeOnly?: boolean;
+}
+export interface BulkComplianceCheckParams {
+    /** List of entities to check (1–100). Each must include at least one of uei, cage, or name. */
+    entities: ComplianceCheckEntity[];
+    /** Enable fuzzy name matching (default: true). Recommended when only names are available. */
+    fuzzyMatch?: boolean;
+}
+//# sourceMappingURL=exclusions.d.ts.map