node-autotask 0.33.0 → 0.37.0

package/capabilities.schema.json

@@ -68,6 +68,7 @@
               "required": [
                 "id",
                 "resource",
+                "udfCapable",
                 "operation",
                 "kind",
                 "effect",
@@ -94,6 +95,9 @@
                 "resource": {
                   "type": "string"
                 },
+                "udfCapable": {
+                  "type": "boolean"
+                },
                 "operation": {
                   "type": "string"
                 },
@@ -396,6 +400,38 @@
                         }
                       }
                     },
+                    "caveats": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "kind",
+                          "note"
+                        ],
+                        "properties": {
+                          "kind": {
+                            "enum": [
+                              "not-persisted"
+                            ]
+                          },
+                          "fields": {
+                            "type": "array",
+                            "items": {
+                              "type": "string",
+                              "minLength": 1
+                            }
+                          },
+                          "note": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "remedyOp": {
+                            "type": "string",
+                            "minLength": 1
+                          }
+                        }
+                      }
+                    },
                     "createRequirements": {
                       "type": "object",
                       "properties": {

package/dist/capabilities.cjs

@@ -2,9 +2,9 @@
 
 
 
-var _chunkSP2SJJZXcjs = require('./chunk-SP2SJJZX.cjs');
+var _chunkHBYKTXN3cjs = require('./chunk-HBYKTXN3.cjs');
 
 
 
 
-exports.CAPABILITIES = _chunkSP2SJJZXcjs.CAPABILITIES; exports.CAPABILITY_GROUPS = _chunkSP2SJJZXcjs.CAPABILITY_GROUPS; exports.CAPABILITY_PLAN_HASHES = _chunkSP2SJJZXcjs.CAPABILITY_PLAN_HASHES;
+exports.CAPABILITIES = _chunkHBYKTXN3cjs.CAPABILITIES; exports.CAPABILITY_GROUPS = _chunkHBYKTXN3cjs.CAPABILITY_GROUPS; exports.CAPABILITY_PLAN_HASHES = _chunkHBYKTXN3cjs.CAPABILITY_PLAN_HASHES;

package/dist/capabilities.d.cts

@@ -25,12 +25,25 @@ interface CapabilityArgSchema {
         default?: number | boolean | string | string[];
     }>;
 }
+/** One per-operation caveat (issue #249): the closed-kind row served on `metadata.caveats`. */
+interface CapabilityCaveat {
+    /** The closed caveat kind. `not-persisted`: the op accepts the listed `fields` but the vendor does not store them. */
+    kind: 'not-persisted';
+    /** The affected vendor field names (required for `not-persisted`). */
+    fields?: string[];
+    /** One sentence for the caller. */
+    note: string;
+    /** The operation id that does what this op cannot (e.g. 'time_entries.moveToTicket'). */
+    remedyOp?: string;
+}
 /** One registered capability (a plan row that is implemented/tested). */
 interface CapabilityRecord {
     /** Plan row id, e.g. 'companies.query' or 'companies.search'. */
     id: string;
     /** Resource key (plan key). */
     resource: string;
+    /** The plan resource's `udfCapable` flag (issue #254): true for the resources whose records carry `userDefinedFields` (a UDF filter needs the `udf: true` marker; a sent list is merged). Every vendor entity also has a `getUdfInfo` catalog endpoint, so that op's presence does NOT mean this. False for the `operations` helpers. */
+    udfCapable: boolean;
     /** Operation name within the resource. */
     operation: string;
     /** 'primitive' rows are the batch-gate surface; 'helper' rows land at the G6 registry. */
@@ -104,6 +117,7 @@ interface CapabilityRecord {
     };
     /** Stable error codes this operation can emit (plan column pass-through). */
     errors: string[];
+    /** The descriptor bag (purpose, usage, ...). Optional `caveats?: CapabilityCaveat[]` (issue #249) names fields an op accepts but the vendor does not store. */
     metadata: Record<string, unknown>;
     /** Compact summary shape name, or null. */
     compact: string | null;
@@ -132,4 +146,4 @@ declare const CAPABILITIES: CapabilityRecord[];
 /** The plan hash per built group (staleness gate input). */
 declare const CAPABILITY_PLAN_HASHES: Record<string, string>;
 
-export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityRecord };
+export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityCaveat, type CapabilityRecord };

package/dist/capabilities.d.ts

@@ -25,12 +25,25 @@ interface CapabilityArgSchema {
         default?: number | boolean | string | string[];
     }>;
 }
+/** One per-operation caveat (issue #249): the closed-kind row served on `metadata.caveats`. */
+interface CapabilityCaveat {
+    /** The closed caveat kind. `not-persisted`: the op accepts the listed `fields` but the vendor does not store them. */
+    kind: 'not-persisted';
+    /** The affected vendor field names (required for `not-persisted`). */
+    fields?: string[];
+    /** One sentence for the caller. */
+    note: string;
+    /** The operation id that does what this op cannot (e.g. 'time_entries.moveToTicket'). */
+    remedyOp?: string;
+}
 /** One registered capability (a plan row that is implemented/tested). */
 interface CapabilityRecord {
     /** Plan row id, e.g. 'companies.query' or 'companies.search'. */
     id: string;
     /** Resource key (plan key). */
     resource: string;
+    /** The plan resource's `udfCapable` flag (issue #254): true for the resources whose records carry `userDefinedFields` (a UDF filter needs the `udf: true` marker; a sent list is merged). Every vendor entity also has a `getUdfInfo` catalog endpoint, so that op's presence does NOT mean this. False for the `operations` helpers. */
+    udfCapable: boolean;
     /** Operation name within the resource. */
     operation: string;
     /** 'primitive' rows are the batch-gate surface; 'helper' rows land at the G6 registry. */
@@ -104,6 +117,7 @@ interface CapabilityRecord {
     };
     /** Stable error codes this operation can emit (plan column pass-through). */
     errors: string[];
+    /** The descriptor bag (purpose, usage, ...). Optional `caveats?: CapabilityCaveat[]` (issue #249) names fields an op accepts but the vendor does not store. */
     metadata: Record<string, unknown>;
     /** Compact summary shape name, or null. */
     compact: string | null;
@@ -132,4 +146,4 @@ declare const CAPABILITIES: CapabilityRecord[];
 /** The plan hash per built group (staleness gate input). */
 declare const CAPABILITY_PLAN_HASHES: Record<string, string>;
 
-export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityRecord };
+export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityCaveat, type CapabilityRecord };

package/dist/capabilities.js

@@ -2,7 +2,7 @@ import {
   CAPABILITIES,
   CAPABILITY_GROUPS,
   CAPABILITY_PLAN_HASHES
-} from "./chunk-VKE56TTN.js";
+} from "./chunk-KQ6HMBB4.js";
 export {
   CAPABILITIES,
   CAPABILITY_GROUPS,

package/dist/{chunk-7WNE5MPG.js → chunk-2PJCQGXZ.js}

@@ -1,14 +1,11 @@
 import {
   AppointmentsResource,
   AuthenticateResource,
-  BillingCodesResource,
   BillingItemApprovalLevelsResource,
-  BillingItemsResource,
   ChangeRequestLinksResource,
   ChecklistLibrariesResource,
   ChecklistLibraryChecklistItemsResource,
   ClassificationIconsResource,
-  CompaniesResource,
   CompanyAlertsResource,
   CompanyLocationsResource,
   CompanyNotesResource,
@@ -49,7 +46,6 @@ import {
   ContractServiceUnitsResource,
   ContractServicesResource,
   ContractTicketPurchasesResource,
-  ContractsResource,
   CountriesResource,
   CurrenciesResource,
   DepartmentsResource,
@@ -62,15 +58,11 @@ import {
   HolidaysResource,
   InventoryProductsResource,
   InvoiceTemplatesResource,
-  InvoicesResource,
   ModulesResource,
   NotificationHistoryResource,
   OpportunitiesResource,
   OpportunityAttachmentsResource,
   OpportunityCategoriesResource,
-  OrganizationalLevel1sResource,
-  OrganizationalLevel2sResource,
-  OrganizationalLevelAssociationsResource,
   PhasesResource,
   ProductVendorsResource,
   ProductsResource,
@@ -91,7 +83,6 @@ import {
   ResourceTimeOffAdditionalResource,
   ResourceTimeOffApproversResource,
   ResourceTimeOffBalancesResource,
-  ResourcesResource,
   RolesResource,
   SalesOrdersResource,
   ServiceCallTaskResourcesResource,
@@ -129,19 +120,28 @@ import {
   TicketSecondaryResourcesResource,
   TicketWebhooksResource,
   TicketsResource,
-  TimeEntriesResource,
   TimeEntryAttachmentsResource,
   TimeOffRequestsResource,
   VersionInformationResource,
   VersionResource,
   ZoneInformationResource
-} from "./chunk-5DS6F6GF.js";
+} from "./chunk-75WJS26D.js";
 import {
   AutotaskConfigError,
+  BillingCodesResource,
+  BillingItemsResource,
+  CompaniesResource,
+  ContractsResource,
   HttpClient,
+  InvoicesResource,
+  OrganizationalLevel1sResource,
+  OrganizationalLevel2sResource,
+  OrganizationalLevelAssociationsResource,
+  ResourcesResource,
+  TimeEntriesResource,
   resolveConfig,
   runWithSignal
-} from "./chunk-MFDQHFGJ.js";
+} from "./chunk-CH2WXTYD.js";
 
 // src/client.ts
 var AutotaskClient = class {