node-autotask 0.34.0 → 0.37.1

package/dist/operations/index.d.cts

@@ -1,5 +1,5 @@
-import { a as AutotaskClient, ev as BlindSurfaceInfo, ew as RelationshipResource, ex as BlindSurfaceInventory, ey as BlindSurfaceRow, ez as CreateGuidanceValueRequirement, eA as CreateGuidanceRow, eB as CreateBlockerKind, eC as CreateGuidanceReport, Z as ZoneName, eD as FieldCacheKind, k as AutotaskConfigError } from '../index-Dx4-zpDo.cjs';
-export { eE as FIELD_CACHE_KINDS } from '../index-Dx4-zpDo.cjs';
+import { a as AutotaskClient, eF as BlindSurfaceInfo, eG as RelationshipResource, eH as BlindSurfaceInventory, eI as BlindSurfaceRow, eJ as CreateGuidanceValueRequirement, eK as CreateGuidanceRow, eL as CreateBlockerKind, eM as CreateGuidanceReport, Z as ZoneName, eN as FieldCacheKind, k as AutotaskConfigError } from '../index-CqepIQfp.cjs';
+export { eO as FIELD_CACHE_KINDS } from '../index-CqepIQfp.cjs';
 import { I as Identifier, cX as EmptyReasonInfo, e9 as PickListValue, a as FilterCondition } from '../index-m-7fOwFl.cjs';
 export { hV as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-m-7fOwFl.cjs';
 import { CapabilityRecord } from '../capabilities.cjs';
@@ -287,6 +287,146 @@ interface AggregateResult {
  */
 declare function aggregate(client: AutotaskClient, operation: string, filter: unknown, opts?: AggregateOptions): Promise<AggregateResult>;
 
+type RevenueRollupDimension = 'vertical' | 'contractType' | 'contractCategory' | 'company' | 'month' | 'billingItemKind' | 'contract' | 'lineOfBusiness' | 'resource' | 'billingCode';
+/** The closed opts bag. Exactly one scope key is required. */
+interface RevenueRollupOptions {
+    companyIDs?: number[];
+    /** `companies.ownerResourceID`, resolved to company ids (one projected query) before the walk. */
+    ownerResourceID?: number;
+    contractIDs?: number[];
+    tenantWide?: true;
+    /** 'YYYY-MM-DD', inclusive. */
+    dateFrom: string;
+    /** 'YYYY-MM-DD', inclusive; window ≤ 36 months. */
+    dateTo: string;
+    /** Ids or labels; default = the live labels that START with 'Recurring' or 'Fixed' (case-insensitive). */
+    contractTypes?: Array<number | string>;
+    contractCategories?: Array<number | string>;
+    /** Default ['vertical', 'contractType']. */
+    groupBy?: RevenueRollupDimension[];
+    /** Rows kept (default 100, cap 100); the tail folds into `rowsTruncated`. */
+    top?: number;
+    /** Vendor-call budget (default 90, or 150 with includeNonChargeable; cap 200). */
+    maxVendorCalls?: number;
+    /** Add per-row non-chargeable work (contract-covered and non-billable: value + hours), never added to revenue. Default false. */
+    includeNonChargeable?: boolean;
+}
+/** A dimension value: picklist text in `label`, vendor entity text (untrusted) in `name` (and, for lineOfBusiness, `division`). */
+interface RevenueRollupKey {
+    id: number | string | null;
+    label?: string;
+    name?: string;
+    division?: string;
+}
+interface RevenueRollupAmount {
+    amount: number;
+    lines: number;
+}
+/** Non-chargeable work: Σ internalCurrencyExtendedPrice (`value`), Σ quantity on labour lines (`hours`), line count. */
+interface RevenueRollupNonChargeableAmount {
+    value: number;
+    hours: number;
+    lines: number;
+}
+interface RevenueRollupNonChargeable {
+    contractCovered: RevenueRollupNonChargeableAmount;
+    nonBillable: RevenueRollupNonChargeableAmount;
+}
+interface RevenueRollupRow {
+    keys: Partial<Record<RevenueRollupDimension, RevenueRollupKey>>;
+    revenue: number;
+    credits: RevenueRollupAmount;
+    includedValue: number;
+    contracts: number;
+    items: number;
+    /** Only with includeNonChargeable; never part of `revenue`. */
+    nonChargeable?: RevenueRollupNonChargeable;
+}
+interface RevenueRollupResult {
+    window: {
+        dateFrom: string;
+        dateTo: string;
+        basis: 'invoiceDate';
+    };
+    scope: {
+        kind: 'companyIDs' | 'ownerResourceID' | 'contractIDs' | 'tenantWide';
+        ownerResourceID?: number;
+        ids?: number[];
+    };
+    groupBy: RevenueRollupDimension[];
+    top: number;
+    rows: RevenueRollupRow[];
+    rowsTruncated?: {
+        rows: number;
+        revenue: number;
+    };
+    totals: {
+        revenue: number;
+        credits: number;
+        includedValue: number;
+        contracts: number;
+        items: number;
+        nonChargeable?: RevenueRollupNonChargeable;
+    };
+    coverage: {
+        /** Logical vendor requests through the budget wrapper; transport retries (429 / 5xx, up to maxRetries each) are not counted. */
+        vendorCalls: number;
+        budget: number;
+        estimate: number;
+        /** vendorCalls as a share of the 10,000/h tenant limit (a floor: transport retries are not counted). */
+        tenantHourlyShare: string;
+        contractTypeMap: Record<string, string>;
+        contractCategoryMap?: Record<string, string>;
+        reconciliation: {
+            headerTotal: number;
+            lineTotal: number;
+            delta: number;
+            invoicesChecked: number;
+            invoicesMismatched: number;
+        };
+        /** Informational overlay, NOT an excluded bucket: zero-total invoices in scope and their lines (those lines are still folded into rows / the buckets). */
+        zeroTotalInvoices: {
+            count: number;
+        } & RevenueRollupAmount;
+        excluded: {
+            /** Header figures of the window's voided invoices in scope (company scopes: header companyID in scope). Absent for a contractIDs scope: an invoice header cannot be attributed to a contract. */
+            voidedInvoices?: {
+                count: number;
+                headerAmount: number;
+            };
+            uncontracted: RevenueRollupAmount;
+            otherContractTypes: Record<string, RevenueRollupAmount>;
+            otherContractCategories: Record<string, RevenueRollupAmount>;
+            unresolvedContracts: RevenueRollupAmount;
+            unresolvedCompanies: RevenueRollupAmount;
+            /** Only when lineOfBusiness is grouped: a line association (or its level1/level2) the id-in fetch did not return. */
+            unresolvedAssociations?: RevenueRollupAmount;
+            /** Only when resource is grouped: a labour line's time entry (or its resource) the id-in fetch did not return. */
+            unresolvedTimeEntries?: RevenueRollupAmount;
+            /** Only when billingCode is grouped: a line billing code the id-in fetch did not return. */
+            unresolvedBillingCodes?: RevenueRollupAmount;
+            /** Only with includeNonChargeable: invoiced and uninvoiced non-chargeable lines whose row could not be resolved (a contract, company or join miss; amount = Σ value). */
+            unresolvedNonChargeable?: RevenueRollupAmount;
+        };
+        /** Only when lineOfBusiness is grouped: in-scope lines with no LOB pointer (also their own "no LOB assigned" row). */
+        lineOfBusiness?: {
+            noPointer: RevenueRollupAmount;
+            note: string;
+        };
+        blindSurfaces: string[];
+        notes: string[];
+    };
+}
+/**
+ * `operations.revenueRollup` — see the module header.
+ *
+ * ```ts
+ * import { revenueRollup } from 'node-autotask/operations';
+ * const r = await revenueRollup(client, { tenantWide: true, dateFrom: '2025-07-01', dateTo: '2026-06-30' });
+ * ```
+ */
+declare function revenueRollup(client: AutotaskClient, opts: RevenueRollupOptions): Promise<RevenueRollupResult>;
+
 /** The pinned per-call item cap (total items per call, mixed resources — the issue's "500 ids" budget; over → CONFIG_ERROR pre-request, zero wire). */
 declare const FETCH_BY_IDS_MAX_ITEMS = 500;
 /** The pinned `id in` chunk size (250/chunk — the chunk query is a single page: 250 is well under the 500 vendor page max). */
@@ -696,7 +836,7 @@ interface FieldCatalogRow {
     resource: string;
     /** The vendor entity name (the path segment; plan-derived). */
     apiEntity: string;
-    /** True when the plan carries a `getUdfInfo` row for the resource (the vendor defines a UDF catalog endpoint for every entity resource — the catalog may answer an empty list). */
+    /** The plan resource's `udfCapable` flag, read from the registry record (`CapabilityRecord.udfCapable`, issue #254): true for the resources whose records carry `userDefinedFields`. Every vendor entity has a `getUdfInfo` catalog endpoint, so the `udf` include works on any row; that endpoint's presence does not make a resource UDF-capable. */
     udfCapable: boolean;
     /** The filter mechanism for a UDF name — present exactly when `udfCapable`: a filter on a UDF name is accepted only with the vendor's `udf: true` marker (a plain filter is refused), so the row states the marker rather than leaving a consumer to read the UDF rows' `isQueryable` (issue #219 N7). */
     udfFilter?: 'udf-marker';
@@ -759,7 +899,7 @@ interface FieldCatalogResult {
         resources: number;
         /** The plan's `getFieldInfo`-bearing resource count (the field-capable set). */
         fieldCapableResources: number;
-        /** The plan's `getUdfInfo`-bearing resource count (the vendor defines a UDF catalog endpoint for these; the narrower plan `udfCapable` flag — entities that actually carry UDFs — is a subset). */
+        /** The plan's `udfCapable` resource count (issue #254: the resources whose records carry `userDefinedFields` — not the wider set with a `getUdfInfo` catalog endpoint). */
         udfCapableResources: number;
         /** The rows served fully from the cache. */
         cached: number;
@@ -1081,4 +1221,4 @@ declare function invokeWrite(client: AutotaskClient, operation: string, args?: r
  */
 declare function invokeDelete(client: AutotaskClient, operation: string, args?: readonly unknown[] | Record<string, unknown>, opts?: InvokeOptions): Promise<unknown>;
 
-export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, type DerivationRule, ENTITY_TYPE_TO_RESOURCE, EXPAND_RESOURCE_NAMES_MAX_IDS, type EffectiveRequiredFields, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, type FieldDerivation, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type RequiredFieldsRecord, type RequiredFieldsSource, type RequiredFieldsZoneFacts, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, type ServedCreateGuidanceReport, type ServedCreateGuidanceRow, UI_LINK_ENTITIES, type UiLinkEntity, type UiLinkInput, type UiLinkResult, WORKFLOW_RESOURCES, aggregate, blindSurfaces, buildUiLink, createGuidance, dateBucketLabel, effectiveRequiredFields, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, foldFlattenedOpts, invoke, invokeDelete, invokeRead, invokeWrite, isEnumerableResource, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, resourceForEntityType, searchAcrossResources, uiLink, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };
+export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, type DerivationRule, ENTITY_TYPE_TO_RESOURCE, EXPAND_RESOURCE_NAMES_MAX_IDS, type EffectiveRequiredFields, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, type FieldDerivation, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type RequiredFieldsRecord, type RequiredFieldsSource, type RequiredFieldsZoneFacts, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type RevenueRollupAmount, type RevenueRollupDimension, type RevenueRollupKey, type RevenueRollupNonChargeable, type RevenueRollupNonChargeableAmount, type RevenueRollupOptions, type RevenueRollupResult, type RevenueRollupRow, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, type ServedCreateGuidanceReport, type ServedCreateGuidanceRow, UI_LINK_ENTITIES, type UiLinkEntity, type UiLinkInput, type UiLinkResult, WORKFLOW_RESOURCES, aggregate, blindSurfaces, buildUiLink, createGuidance, dateBucketLabel, effectiveRequiredFields, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, foldFlattenedOpts, invoke, invokeDelete, invokeRead, invokeWrite, isEnumerableResource, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, resourceForEntityType, revenueRollup, searchAcrossResources, uiLink, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };

package/dist/operations/index.d.ts

@@ -1,5 +1,5 @@
-import { a as AutotaskClient, ev as BlindSurfaceInfo, ew as RelationshipResource, ex as BlindSurfaceInventory, ey as BlindSurfaceRow, ez as CreateGuidanceValueRequirement, eA as CreateGuidanceRow, eB as CreateBlockerKind, eC as CreateGuidanceReport, Z as ZoneName, eD as FieldCacheKind, k as AutotaskConfigError } from '../index-ByMU8IC2.js';
-export { eE as FIELD_CACHE_KINDS } from '../index-ByMU8IC2.js';
+import { a as AutotaskClient, eF as BlindSurfaceInfo, eG as RelationshipResource, eH as BlindSurfaceInventory, eI as BlindSurfaceRow, eJ as CreateGuidanceValueRequirement, eK as CreateGuidanceRow, eL as CreateBlockerKind, eM as CreateGuidanceReport, Z as ZoneName, eN as FieldCacheKind, k as AutotaskConfigError } from '../index-BDqw377y.js';
+export { eO as FIELD_CACHE_KINDS } from '../index-BDqw377y.js';
 import { I as Identifier, cX as EmptyReasonInfo, e9 as PickListValue, a as FilterCondition } from '../index-m-7fOwFl.js';
 export { hV as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-m-7fOwFl.js';
 import { CapabilityRecord } from '../capabilities.js';
@@ -287,6 +287,146 @@ interface AggregateResult {
  */
 declare function aggregate(client: AutotaskClient, operation: string, filter: unknown, opts?: AggregateOptions): Promise<AggregateResult>;
 
+type RevenueRollupDimension = 'vertical' | 'contractType' | 'contractCategory' | 'company' | 'month' | 'billingItemKind' | 'contract' | 'lineOfBusiness' | 'resource' | 'billingCode';
+/** The closed opts bag. Exactly one scope key is required. */
+interface RevenueRollupOptions {
+    companyIDs?: number[];
+    /** `companies.ownerResourceID`, resolved to company ids (one projected query) before the walk. */
+    ownerResourceID?: number;
+    contractIDs?: number[];
+    tenantWide?: true;
+    /** 'YYYY-MM-DD', inclusive. */
+    dateFrom: string;
+    /** 'YYYY-MM-DD', inclusive; window ≤ 36 months. */
+    dateTo: string;
+    /** Ids or labels; default = the live labels that START with 'Recurring' or 'Fixed' (case-insensitive). */
+    contractTypes?: Array<number | string>;
+    contractCategories?: Array<number | string>;
+    /** Default ['vertical', 'contractType']. */
+    groupBy?: RevenueRollupDimension[];
+    /** Rows kept (default 100, cap 100); the tail folds into `rowsTruncated`. */
+    top?: number;
+    /** Vendor-call budget (default 90, or 150 with includeNonChargeable; cap 200). */
+    maxVendorCalls?: number;
+    /** Add per-row non-chargeable work (contract-covered and non-billable: value + hours), never added to revenue. Default false. */
+    includeNonChargeable?: boolean;
+}
+/** A dimension value: picklist text in `label`, vendor entity text (untrusted) in `name` (and, for lineOfBusiness, `division`). */
+interface RevenueRollupKey {
+    id: number | string | null;
+    label?: string;
+    name?: string;
+    division?: string;
+}
+interface RevenueRollupAmount {
+    amount: number;
+    lines: number;
+}
+/** Non-chargeable work: Σ internalCurrencyExtendedPrice (`value`), Σ quantity on labour lines (`hours`), line count. */
+interface RevenueRollupNonChargeableAmount {
+    value: number;
+    hours: number;
+    lines: number;
+}
+interface RevenueRollupNonChargeable {
+    contractCovered: RevenueRollupNonChargeableAmount;
+    nonBillable: RevenueRollupNonChargeableAmount;
+}
+interface RevenueRollupRow {
+    keys: Partial<Record<RevenueRollupDimension, RevenueRollupKey>>;
+    revenue: number;
+    credits: RevenueRollupAmount;
+    includedValue: number;
+    contracts: number;
+    items: number;
+    /** Only with includeNonChargeable; never part of `revenue`. */
+    nonChargeable?: RevenueRollupNonChargeable;
+}
+interface RevenueRollupResult {
+    window: {
+        dateFrom: string;
+        dateTo: string;
+        basis: 'invoiceDate';
+    };
+    scope: {
+        kind: 'companyIDs' | 'ownerResourceID' | 'contractIDs' | 'tenantWide';
+        ownerResourceID?: number;
+        ids?: number[];
+    };
+    groupBy: RevenueRollupDimension[];
+    top: number;
+    rows: RevenueRollupRow[];
+    rowsTruncated?: {
+        rows: number;
+        revenue: number;
+    };
+    totals: {
+        revenue: number;
+        credits: number;
+        includedValue: number;
+        contracts: number;
+        items: number;
+        nonChargeable?: RevenueRollupNonChargeable;
+    };
+    coverage: {
+        /** Logical vendor requests through the budget wrapper; transport retries (429 / 5xx, up to maxRetries each) are not counted. */
+        vendorCalls: number;
+        budget: number;
+        estimate: number;
+        /** vendorCalls as a share of the 10,000/h tenant limit (a floor: transport retries are not counted). */
+        tenantHourlyShare: string;
+        contractTypeMap: Record<string, string>;
+        contractCategoryMap?: Record<string, string>;
+        reconciliation: {
+            headerTotal: number;
+            lineTotal: number;
+            delta: number;
+            invoicesChecked: number;
+            invoicesMismatched: number;
+        };
+        /** Informational overlay, NOT an excluded bucket: zero-total invoices in scope and their lines (those lines are still folded into rows / the buckets). */
+        zeroTotalInvoices: {
+            count: number;
+        } & RevenueRollupAmount;
+        excluded: {
+            /** Header figures of the window's voided invoices in scope (company scopes: header companyID in scope). Absent for a contractIDs scope: an invoice header cannot be attributed to a contract. */
+            voidedInvoices?: {
+                count: number;
+                headerAmount: number;
+            };
+            uncontracted: RevenueRollupAmount;
+            otherContractTypes: Record<string, RevenueRollupAmount>;
+            otherContractCategories: Record<string, RevenueRollupAmount>;
+            unresolvedContracts: RevenueRollupAmount;
+            unresolvedCompanies: RevenueRollupAmount;
+            /** Only when lineOfBusiness is grouped: a line association (or its level1/level2) the id-in fetch did not return. */
+            unresolvedAssociations?: RevenueRollupAmount;
+            /** Only when resource is grouped: a labour line's time entry (or its resource) the id-in fetch did not return. */
+            unresolvedTimeEntries?: RevenueRollupAmount;
+            /** Only when billingCode is grouped: a line billing code the id-in fetch did not return. */
+            unresolvedBillingCodes?: RevenueRollupAmount;
+            /** Only with includeNonChargeable: invoiced and uninvoiced non-chargeable lines whose row could not be resolved (a contract, company or join miss; amount = Σ value). */
+            unresolvedNonChargeable?: RevenueRollupAmount;
+        };
+        /** Only when lineOfBusiness is grouped: in-scope lines with no LOB pointer (also their own "no LOB assigned" row). */
+        lineOfBusiness?: {
+            noPointer: RevenueRollupAmount;
+            note: string;
+        };
+        blindSurfaces: string[];
+        notes: string[];
+    };
+}
+/**
+ * `operations.revenueRollup` — see the module header.
+ *
+ * ```ts
+ * import { revenueRollup } from 'node-autotask/operations';
+ * const r = await revenueRollup(client, { tenantWide: true, dateFrom: '2025-07-01', dateTo: '2026-06-30' });
+ * ```
+ */
+declare function revenueRollup(client: AutotaskClient, opts: RevenueRollupOptions): Promise<RevenueRollupResult>;
+
 /** The pinned per-call item cap (total items per call, mixed resources — the issue's "500 ids" budget; over → CONFIG_ERROR pre-request, zero wire). */
 declare const FETCH_BY_IDS_MAX_ITEMS = 500;
 /** The pinned `id in` chunk size (250/chunk — the chunk query is a single page: 250 is well under the 500 vendor page max). */
@@ -696,7 +836,7 @@ interface FieldCatalogRow {
     resource: string;
     /** The vendor entity name (the path segment; plan-derived). */
     apiEntity: string;
-    /** True when the plan carries a `getUdfInfo` row for the resource (the vendor defines a UDF catalog endpoint for every entity resource — the catalog may answer an empty list). */
+    /** The plan resource's `udfCapable` flag, read from the registry record (`CapabilityRecord.udfCapable`, issue #254): true for the resources whose records carry `userDefinedFields`. Every vendor entity has a `getUdfInfo` catalog endpoint, so the `udf` include works on any row; that endpoint's presence does not make a resource UDF-capable. */
     udfCapable: boolean;
     /** The filter mechanism for a UDF name — present exactly when `udfCapable`: a filter on a UDF name is accepted only with the vendor's `udf: true` marker (a plain filter is refused), so the row states the marker rather than leaving a consumer to read the UDF rows' `isQueryable` (issue #219 N7). */
     udfFilter?: 'udf-marker';
@@ -759,7 +899,7 @@ interface FieldCatalogResult {
         resources: number;
         /** The plan's `getFieldInfo`-bearing resource count (the field-capable set). */
         fieldCapableResources: number;
-        /** The plan's `getUdfInfo`-bearing resource count (the vendor defines a UDF catalog endpoint for these; the narrower plan `udfCapable` flag — entities that actually carry UDFs — is a subset). */
+        /** The plan's `udfCapable` resource count (issue #254: the resources whose records carry `userDefinedFields` — not the wider set with a `getUdfInfo` catalog endpoint). */
         udfCapableResources: number;
         /** The rows served fully from the cache. */
         cached: number;
@@ -1081,4 +1221,4 @@ declare function invokeWrite(client: AutotaskClient, operation: string, args?: r
  */
 declare function invokeDelete(client: AutotaskClient, operation: string, args?: readonly unknown[] | Record<string, unknown>, opts?: InvokeOptions): Promise<unknown>;
 
-export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, type DerivationRule, ENTITY_TYPE_TO_RESOURCE, EXPAND_RESOURCE_NAMES_MAX_IDS, type EffectiveRequiredFields, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, type FieldDerivation, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type RequiredFieldsRecord, type RequiredFieldsSource, type RequiredFieldsZoneFacts, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, type ServedCreateGuidanceReport, type ServedCreateGuidanceRow, UI_LINK_ENTITIES, type UiLinkEntity, type UiLinkInput, type UiLinkResult, WORKFLOW_RESOURCES, aggregate, blindSurfaces, buildUiLink, createGuidance, dateBucketLabel, effectiveRequiredFields, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, foldFlattenedOpts, invoke, invokeDelete, invokeRead, invokeWrite, isEnumerableResource, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, resourceForEntityType, searchAcrossResources, uiLink, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };
+export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, type DerivationRule, ENTITY_TYPE_TO_RESOURCE, EXPAND_RESOURCE_NAMES_MAX_IDS, type EffectiveRequiredFields, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, type FieldDerivation, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type RequiredFieldsRecord, type RequiredFieldsSource, type RequiredFieldsZoneFacts, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type RevenueRollupAmount, type RevenueRollupDimension, type RevenueRollupKey, type RevenueRollupNonChargeable, type RevenueRollupNonChargeableAmount, type RevenueRollupOptions, type RevenueRollupResult, type RevenueRollupRow, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, type ServedCreateGuidanceReport, type ServedCreateGuidanceRow, UI_LINK_ENTITIES, type UiLinkEntity, type UiLinkInput, type UiLinkResult, WORKFLOW_RESOURCES, aggregate, blindSurfaces, buildUiLink, createGuidance, dateBucketLabel, effectiveRequiredFields, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, foldFlattenedOpts, invoke, invokeDelete, invokeRead, invokeWrite, isEnumerableResource, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, resourceForEntityType, revenueRollup, searchAcrossResources, uiLink, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };