node-autotask 0.69.1 → 0.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/MCP_TOOL_CATALOG.json +369 -9
  3. package/README.md +7 -1
  4. package/capabilities.json +1697 -392
  5. package/dist/capabilities-data.js +1696 -391
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-WFVLF7EW.cjs → chunk-4DSLRDIF.cjs} +33 -30
  9. package/dist/{chunk-FK37JXSJ.js → chunk-4OR3XBIP.js} +699 -168
  10. package/dist/{chunk-MMGO3SFL.js → chunk-5COLIVBE.js} +2 -2
  11. package/dist/{chunk-KAZE4WC7.cjs → chunk-JLCHKCEB.cjs} +3 -3
  12. package/dist/{chunk-SCFB5MF3.js → chunk-LKJA57CH.js} +3 -3
  13. package/dist/{chunk-EWXRFHPP.cjs → chunk-QJ327YI6.cjs} +177 -177
  14. package/dist/{chunk-CLHDTYWO.cjs → chunk-QQFF7X67.cjs} +704 -172
  15. package/dist/{chunk-64BMSXWT.js → chunk-YKQ2KNQO.js} +5 -2
  16. package/dist/{index-BT_0tTPS.d.cts → index-CAXT5ZKT.d.cts} +14 -4
  17. package/dist/{index-COQEG55Q.d.cts → index-CM_SRgtH.d.cts} +209 -1
  18. package/dist/{index-COQEG55Q.d.ts → index-CM_SRgtH.d.ts} +209 -1
  19. package/dist/{index-Coe7LFLY.d.ts → index-lGpxr4gY.d.ts} +14 -4
  20. package/dist/index.cjs +84 -84
  21. package/dist/index.d.cts +3 -3
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.js +5 -5
  24. package/dist/operations/index.cjs +54 -50
  25. package/dist/operations/index.d.cts +25 -7
  26. package/dist/operations/index.d.ts +25 -7
  27. package/dist/operations/index.js +2 -2
  28. package/dist/pool.cjs +12 -12
  29. package/dist/pool.d.cts +1 -1
  30. package/dist/pool.d.ts +1 -1
  31. package/dist/pool.js +4 -4
  32. package/dist/resources/index.cjs +27 -27
  33. package/dist/resources/index.d.cts +2 -2
  34. package/dist/resources/index.d.ts +2 -2
  35. package/dist/resources/index.js +3 -3
  36. package/dist/types/index.d.cts +1 -1
  37. package/dist/types/index.d.ts +1 -1
  38. package/docs/API.md +108 -2
  39. package/docs/N8N-ADAPTER.md +1 -1
  40. package/docs/RELEASING.md +11 -3
  41. package/docs/performance-caching.md +92 -0
  42. package/docs/performance-reads.md +9 -1
  43. package/package.json +1 -1
@@ -348,8 +348,8 @@ const CAPABILITY_DATA = {
348
348
  ],
349
349
  "groups": {
350
350
  "B": {
351
- "planHash": "959981d335cfd184d8b4e58074d1ab6997b2db87a62683ed13e99c149f8cd4fa",
352
- "builtAt": "2026-11-17T15:37:22.566Z",
351
+ "planHash": "275fdf2fd6712f9384c1a65f98c5faf1fda9695475ffbdf35c08e574c18b4157",
352
+ "builtAt": "2026-11-18T09:40:46.384Z",
353
353
  "records": [
354
354
  {
355
355
  "id": "appointments.count",
@@ -43132,9 +43132,386 @@ const CAPABILITY_DATA = {
43132
43132
  ]
43133
43133
  },
43134
43134
  "A": {
43135
- "planHash": "959981d335cfd184d8b4e58074d1ab6997b2db87a62683ed13e99c149f8cd4fa",
43136
- "builtAt": "2026-11-17T15:37:22.566Z",
43135
+ "planHash": "275fdf2fd6712f9384c1a65f98c5faf1fda9695475ffbdf35c08e574c18b4157",
43136
+ "builtAt": "2026-11-18T09:40:46.384Z",
43137
43137
  "records": [
43138
+ {
43139
+ "id": "attachment_info.count",
43140
+ "resource": "attachment_info",
43141
+ "udfCapable": false,
43142
+ "operation": "count",
43143
+ "kind": "primitive",
43144
+ "endpoint": "GET|POST /V1.0/AttachmentInfo/query/count",
43145
+ "effect": "read",
43146
+ "flags": [],
43147
+ "dryRun": false,
43148
+ "envelope": "QueryCountResultModel",
43149
+ "inputSchema": {
43150
+ "params": {
43151
+ "type": "object",
43152
+ "required": false,
43153
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
43154
+ "properties": [
43155
+ {
43156
+ "name": "filter",
43157
+ "type": "FilterCondition[]",
43158
+ "optional": true
43159
+ },
43160
+ {
43161
+ "name": "fieldCheck",
43162
+ "type": "boolean",
43163
+ "optional": true
43164
+ }
43165
+ ]
43166
+ }
43167
+ },
43168
+ "inputSchemaStrict": true,
43169
+ "outputSchema": {
43170
+ "type": "QueryCountResultModel",
43171
+ "drops": []
43172
+ },
43173
+ "examples": [
43174
+ "await client.attachmentInfo.count({ filter: [{ field: 'companyID', op: 'eq', value: 1 }] })"
43175
+ ],
43176
+ "permissions": "unknown",
43177
+ "pagination": {
43178
+ "mode": "none"
43179
+ },
43180
+ "resolution": null,
43181
+ "retry": {
43182
+ "preset": "retry-ffb3a9cb"
43183
+ },
43184
+ "errors": {
43185
+ "set": 0
43186
+ },
43187
+ "metadata": {
43188
+ "purpose": "Count attachment information records matching a JSON filter.",
43189
+ "usage": "Unwraps queryCount; returns a plain number. Filter by companyID for company scope. fileSize is not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility.",
43190
+ "preferredWhen": null,
43191
+ "related": [
43192
+ "attachment_info.query"
43193
+ ],
43194
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
43195
+ "untrustedFields": [
43196
+ "title"
43197
+ ]
43198
+ },
43199
+ "compact": null,
43200
+ "status": "tested"
43201
+ },
43202
+ {
43203
+ "id": "attachment_info.get",
43204
+ "resource": "attachment_info",
43205
+ "udfCapable": false,
43206
+ "operation": "get",
43207
+ "kind": "primitive",
43208
+ "endpoint": "GET /V1.0/AttachmentInfo/{id}",
43209
+ "effect": "read",
43210
+ "flags": [],
43211
+ "dryRun": false,
43212
+ "envelope": "ItemQueryResultModel[AttachmentInfoModel,AttachmentInfo]",
43213
+ "inputSchema": {
43214
+ "id": {
43215
+ "type": "string | number",
43216
+ "required": true,
43217
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
43218
+ },
43219
+ "opts": {
43220
+ "type": "object",
43221
+ "required": false,
43222
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
43223
+ "properties": [
43224
+ {
43225
+ "name": "fresh",
43226
+ "type": "boolean",
43227
+ "optional": true
43228
+ }
43229
+ ]
43230
+ }
43231
+ },
43232
+ "inputSchemaStrict": true,
43233
+ "outputSchema": {
43234
+ "type": "ItemQueryResultModel[AttachmentInfoModel,AttachmentInfo]",
43235
+ "drops": []
43236
+ },
43237
+ "examples": [
43238
+ "await client.attachmentInfo.get('example-value')"
43239
+ ],
43240
+ "permissions": "unknown",
43241
+ "pagination": {
43242
+ "mode": "none"
43243
+ },
43244
+ "resolution": null,
43245
+ "retry": {
43246
+ "preset": "retry-ffb3a9cb"
43247
+ },
43248
+ "errors": {
43249
+ "set": 3
43250
+ },
43251
+ "metadata": {
43252
+ "purpose": "Get one AttachmentInfo by id.",
43253
+ "usage": "Returns item from the standard item envelope; item: null is a typed not-found.",
43254
+ "preferredWhen": "Use a known attachment id; query attachment_info with an object-specific filter to discover ids.",
43255
+ "related": [
43256
+ "attachment_info.query"
43257
+ ],
43258
+ "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an attachment_info.query with includeFields.",
43259
+ "untrustedFields": [
43260
+ "title"
43261
+ ]
43262
+ },
43263
+ "compact": null,
43264
+ "status": "tested"
43265
+ },
43266
+ {
43267
+ "id": "attachment_info.getEntityInfo",
43268
+ "resource": "attachment_info",
43269
+ "udfCapable": false,
43270
+ "operation": "getEntityInfo",
43271
+ "kind": "primitive",
43272
+ "endpoint": "GET /V1.0/AttachmentInfo/entityInformation",
43273
+ "effect": "read",
43274
+ "flags": [],
43275
+ "dryRun": false,
43276
+ "envelope": "EntityInformationResultModel",
43277
+ "inputSchema": {},
43278
+ "inputSchemaStrict": true,
43279
+ "outputSchema": {
43280
+ "type": "EntityInformationResultModel",
43281
+ "drops": []
43282
+ },
43283
+ "examples": [
43284
+ "await client.attachmentInfo.getEntityInfo()"
43285
+ ],
43286
+ "permissions": "unknown",
43287
+ "pagination": {
43288
+ "mode": "none"
43289
+ },
43290
+ "resolution": null,
43291
+ "retry": {
43292
+ "preset": "retry-ffb3a9cb"
43293
+ },
43294
+ "errors": {
43295
+ "set": 0
43296
+ },
43297
+ "metadata": {
43298
+ "purpose": "Get the AttachmentInfo capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
43299
+ "usage": "Unwraps info{}; drives client-side capability checks.",
43300
+ "preferredWhen": null,
43301
+ "related": [
43302
+ "attachment_info.getFieldInfo"
43303
+ ],
43304
+ "untrustedFields": [
43305
+ "title"
43306
+ ]
43307
+ },
43308
+ "compact": null,
43309
+ "status": "tested"
43310
+ },
43311
+ {
43312
+ "id": "attachment_info.getFieldInfo",
43313
+ "resource": "attachment_info",
43314
+ "udfCapable": false,
43315
+ "operation": "getFieldInfo",
43316
+ "kind": "primitive",
43317
+ "endpoint": "GET /V1.0/AttachmentInfo/entityInformation/fields",
43318
+ "effect": "read",
43319
+ "flags": [],
43320
+ "dryRun": false,
43321
+ "envelope": "FieldInformationResultModel",
43322
+ "inputSchema": {},
43323
+ "inputSchemaStrict": true,
43324
+ "outputSchema": {
43325
+ "type": "FieldInformationResultModel",
43326
+ "drops": []
43327
+ },
43328
+ "examples": [
43329
+ "await client.attachmentInfo.getFieldInfo()"
43330
+ ],
43331
+ "permissions": "unknown",
43332
+ "pagination": {
43333
+ "mode": "none"
43334
+ },
43335
+ "resolution": null,
43336
+ "retry": {
43337
+ "preset": "retry-ffb3a9cb"
43338
+ },
43339
+ "errors": {
43340
+ "set": 0
43341
+ },
43342
+ "metadata": {
43343
+ "purpose": "Get the AttachmentInfo field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
43344
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
43345
+ "preferredWhen": null,
43346
+ "related": [
43347
+ "attachment_info.getEntityInfo",
43348
+ "attachment_info.getUdfInfo"
43349
+ ],
43350
+ "untrustedFields": [
43351
+ "title"
43352
+ ]
43353
+ },
43354
+ "compact": null,
43355
+ "status": "tested"
43356
+ },
43357
+ {
43358
+ "id": "attachment_info.getUdfInfo",
43359
+ "resource": "attachment_info",
43360
+ "udfCapable": false,
43361
+ "operation": "getUdfInfo",
43362
+ "kind": "primitive",
43363
+ "endpoint": "GET /V1.0/AttachmentInfo/entityInformation/userDefinedFields",
43364
+ "effect": "read",
43365
+ "flags": [],
43366
+ "dryRun": false,
43367
+ "envelope": "UserDefinedFieldInformationResultModel",
43368
+ "inputSchema": {},
43369
+ "inputSchemaStrict": true,
43370
+ "outputSchema": {
43371
+ "type": "UserDefinedFieldInformationResultModel",
43372
+ "drops": []
43373
+ },
43374
+ "examples": [
43375
+ "await client.attachmentInfo.getUdfInfo()"
43376
+ ],
43377
+ "permissions": "unknown",
43378
+ "pagination": {
43379
+ "mode": "none"
43380
+ },
43381
+ "resolution": null,
43382
+ "retry": {
43383
+ "preset": "retry-ffb3a9cb"
43384
+ },
43385
+ "errors": {
43386
+ "set": 0
43387
+ },
43388
+ "metadata": {
43389
+ "purpose": "Get the AttachmentInfo user-defined-field catalog.",
43390
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
43391
+ "preferredWhen": null,
43392
+ "related": [
43393
+ "attachment_info.getFieldInfo"
43394
+ ],
43395
+ "untrustedFields": [
43396
+ "title"
43397
+ ]
43398
+ },
43399
+ "compact": null,
43400
+ "status": "tested"
43401
+ },
43402
+ {
43403
+ "id": "attachment_info.query",
43404
+ "resource": "attachment_info",
43405
+ "udfCapable": false,
43406
+ "operation": "query",
43407
+ "kind": "primitive",
43408
+ "endpoint": "GET|POST /V1.0/AttachmentInfo/query",
43409
+ "effect": "read",
43410
+ "flags": [],
43411
+ "dryRun": false,
43412
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
43413
+ "inputSchema": {
43414
+ "params": {
43415
+ "type": "object",
43416
+ "required": false,
43417
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
43418
+ "properties": [
43419
+ {
43420
+ "name": "filter",
43421
+ "type": "FilterCondition[]",
43422
+ "optional": true
43423
+ },
43424
+ {
43425
+ "name": "limit",
43426
+ "type": "number",
43427
+ "optional": true,
43428
+ "default": 500
43429
+ },
43430
+ {
43431
+ "name": "latest",
43432
+ "type": "number",
43433
+ "optional": true
43434
+ },
43435
+ {
43436
+ "name": "noteChars",
43437
+ "type": "number",
43438
+ "optional": true
43439
+ },
43440
+ {
43441
+ "name": "includeFields",
43442
+ "type": "string[]",
43443
+ "optional": true
43444
+ },
43445
+ {
43446
+ "name": "fieldCheck",
43447
+ "type": "boolean",
43448
+ "optional": true,
43449
+ "default": true
43450
+ },
43451
+ {
43452
+ "name": "names",
43453
+ "type": "boolean",
43454
+ "optional": true
43455
+ },
43456
+ {
43457
+ "name": "via",
43458
+ "type": "\"post\" | \"get\"",
43459
+ "optional": true
43460
+ },
43461
+ {
43462
+ "name": "acknowledgeUnscoped",
43463
+ "type": "boolean",
43464
+ "optional": true
43465
+ },
43466
+ {
43467
+ "name": "walk",
43468
+ "type": "object",
43469
+ "optional": true
43470
+ }
43471
+ ]
43472
+ }
43473
+ },
43474
+ "inputSchemaStrict": true,
43475
+ "outputSchema": {
43476
+ "type": "QueryActionResult[<Model>,<Entity>]",
43477
+ "drops": []
43478
+ },
43479
+ "examples": [
43480
+ "await client.attachmentInfo.query({ filter: [{ field: 'companyID', op: 'eq', value: 1 }], limit: 25 })"
43481
+ ],
43482
+ "permissions": "unknown",
43483
+ "pagination": {
43484
+ "mode": "cursor",
43485
+ "vendorDefault": 10,
43486
+ "vendorMax": 500,
43487
+ "pageGuard": 1000,
43488
+ "queryBounded": {
43489
+ "default": 500,
43490
+ "max": 2500
43491
+ }
43492
+ },
43493
+ "resolution": null,
43494
+ "retry": {
43495
+ "preset": "retry-ffb3a9cb"
43496
+ },
43497
+ "errors": {
43498
+ "set": 4
43499
+ },
43500
+ "metadata": {
43501
+ "purpose": "Query AttachmentInfo records with a JSON filter.",
43502
+ "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Filter by companyID for company scope. fileSize is not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility.",
43503
+ "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
43504
+ "related": [
43505
+ "attachment_info.get"
43506
+ ],
43507
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
43508
+ "untrustedFields": [
43509
+ "title"
43510
+ ]
43511
+ },
43512
+ "compact": null,
43513
+ "status": "tested"
43514
+ },
43138
43515
  {
43139
43516
  "id": "companies.count",
43140
43517
  "resource": "companies",
@@ -44874,7 +45251,1099 @@ const CAPABILITY_DATA = {
44874
45251
  "drops": []
44875
45252
  },
44876
45253
  "examples": [
44877
- "await client.companyAlerts.create('example-value', { name: 'example' }, { dryRun: true })"
45254
+ "await client.companyAlerts.create('example-value', { name: 'example' }, { dryRun: true })"
45255
+ ],
45256
+ "permissions": "unknown",
45257
+ "pagination": {
45258
+ "mode": "none"
45259
+ },
45260
+ "resolution": null,
45261
+ "retry": {
45262
+ "preset": "retry-c5657094"
45263
+ },
45264
+ "errors": {
45265
+ "set": 1
45266
+ },
45267
+ "metadata": {
45268
+ "purpose": "Create a company alert.",
45269
+ "usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
45270
+ "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
45271
+ "related": [
45272
+ "company_alerts.update"
45273
+ ],
45274
+ "untrustedFields": [
45275
+ "alertText"
45276
+ ]
45277
+ },
45278
+ "compact": null,
45279
+ "status": "tested"
45280
+ },
45281
+ {
45282
+ "id": "company_alerts.delete",
45283
+ "resource": "company_alerts",
45284
+ "udfCapable": false,
45285
+ "operation": "delete",
45286
+ "kind": "primitive",
45287
+ "endpoint": "DELETE /V1.0/Companies/{parentId}/Alerts/{id}",
45288
+ "effect": "destructive",
45289
+ "flags": [
45290
+ "idempotent",
45291
+ "requiresApproval"
45292
+ ],
45293
+ "dryRun": true,
45294
+ "envelope": "OperationResultModel",
45295
+ "inputSchema": {
45296
+ "parentId": {
45297
+ "type": "string | number",
45298
+ "required": true,
45299
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45300
+ },
45301
+ "id": {
45302
+ "type": "string | number",
45303
+ "required": true,
45304
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
45305
+ }
45306
+ },
45307
+ "inputSchemaStrict": true,
45308
+ "outputSchema": {
45309
+ "type": "OperationResultModel",
45310
+ "drops": []
45311
+ },
45312
+ "examples": [
45313
+ "await invoke(client, 'company_alerts.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_alerts.delete' })"
45314
+ ],
45315
+ "permissions": "unknown",
45316
+ "pagination": {
45317
+ "mode": "none"
45318
+ },
45319
+ "resolution": null,
45320
+ "retry": {
45321
+ "preset": "retry-1849870d"
45322
+ },
45323
+ "errors": {
45324
+ "set": 2
45325
+ },
45326
+ "metadata": {
45327
+ "purpose": "Delete a company alert.",
45328
+ "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
45329
+ "preferredWhen": null,
45330
+ "related": [
45331
+ "company_alerts.get"
45332
+ ],
45333
+ "untrustedFields": [
45334
+ "alertText"
45335
+ ]
45336
+ },
45337
+ "compact": null,
45338
+ "status": "tested"
45339
+ },
45340
+ {
45341
+ "id": "company_alerts.get",
45342
+ "resource": "company_alerts",
45343
+ "udfCapable": false,
45344
+ "operation": "get",
45345
+ "kind": "primitive",
45346
+ "endpoint": "GET /V1.0/Companies/{parentId}/Alerts/{id}",
45347
+ "effect": "read",
45348
+ "flags": [],
45349
+ "dryRun": false,
45350
+ "envelope": "ItemQueryResultModel[CompanyAlertModel,AccountAlert]",
45351
+ "inputSchema": {
45352
+ "parentId": {
45353
+ "type": "string | number",
45354
+ "required": true,
45355
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45356
+ },
45357
+ "id": {
45358
+ "type": "string | number",
45359
+ "required": true,
45360
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
45361
+ },
45362
+ "opts": {
45363
+ "type": "object",
45364
+ "required": false,
45365
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
45366
+ "properties": [
45367
+ {
45368
+ "name": "fresh",
45369
+ "type": "boolean",
45370
+ "optional": true
45371
+ }
45372
+ ]
45373
+ }
45374
+ },
45375
+ "inputSchemaStrict": true,
45376
+ "outputSchema": {
45377
+ "type": "ItemQueryResultModel[CompanyAlertModel,AccountAlert]",
45378
+ "drops": []
45379
+ },
45380
+ "examples": [
45381
+ "await client.companyAlerts.get('example-value', 'example-value')"
45382
+ ],
45383
+ "permissions": "unknown",
45384
+ "pagination": {
45385
+ "mode": "none"
45386
+ },
45387
+ "resolution": null,
45388
+ "retry": {
45389
+ "preset": "retry-ffb3a9cb"
45390
+ },
45391
+ "errors": {
45392
+ "set": 3
45393
+ },
45394
+ "metadata": {
45395
+ "purpose": "Get one CompanyAlert by id.",
45396
+ "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
45397
+ "preferredWhen": "Preferred when the numeric id is already known; company_alerts.resolve is for a field value.",
45398
+ "related": [
45399
+ "company_alerts.resolve"
45400
+ ],
45401
+ "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a company_alerts.query with includeFields.",
45402
+ "untrustedFields": [
45403
+ "alertText"
45404
+ ]
45405
+ },
45406
+ "compact": null,
45407
+ "status": "tested"
45408
+ },
45409
+ {
45410
+ "id": "company_alerts.getEntityInfo",
45411
+ "resource": "company_alerts",
45412
+ "udfCapable": false,
45413
+ "operation": "getEntityInfo",
45414
+ "kind": "primitive",
45415
+ "endpoint": "GET /V1.0/CompanyAlerts/entityInformation",
45416
+ "effect": "read",
45417
+ "flags": [],
45418
+ "dryRun": false,
45419
+ "envelope": "EntityInformationResultModel",
45420
+ "inputSchema": {},
45421
+ "inputSchemaStrict": true,
45422
+ "outputSchema": {
45423
+ "type": "EntityInformationResultModel",
45424
+ "drops": []
45425
+ },
45426
+ "examples": [
45427
+ "await client.companyAlerts.getEntityInfo()"
45428
+ ],
45429
+ "permissions": "unknown",
45430
+ "pagination": {
45431
+ "mode": "none"
45432
+ },
45433
+ "resolution": null,
45434
+ "retry": {
45435
+ "preset": "retry-ffb3a9cb"
45436
+ },
45437
+ "errors": {
45438
+ "set": 0
45439
+ },
45440
+ "metadata": {
45441
+ "purpose": "Get the CompanyAlert capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
45442
+ "usage": "Unwraps info{}; drives client-side capability checks.",
45443
+ "preferredWhen": null,
45444
+ "related": [
45445
+ "company_alerts.getFieldInfo"
45446
+ ],
45447
+ "untrustedFields": [
45448
+ "alertText"
45449
+ ]
45450
+ },
45451
+ "compact": null,
45452
+ "status": "tested"
45453
+ },
45454
+ {
45455
+ "id": "company_alerts.getFieldInfo",
45456
+ "resource": "company_alerts",
45457
+ "udfCapable": false,
45458
+ "operation": "getFieldInfo",
45459
+ "kind": "primitive",
45460
+ "endpoint": "GET /V1.0/CompanyAlerts/entityInformation/fields",
45461
+ "effect": "read",
45462
+ "flags": [],
45463
+ "dryRun": false,
45464
+ "envelope": "FieldInformationResultModel",
45465
+ "inputSchema": {},
45466
+ "inputSchemaStrict": true,
45467
+ "outputSchema": {
45468
+ "type": "FieldInformationResultModel",
45469
+ "drops": []
45470
+ },
45471
+ "examples": [
45472
+ "await client.companyAlerts.getFieldInfo()"
45473
+ ],
45474
+ "permissions": "unknown",
45475
+ "pagination": {
45476
+ "mode": "none"
45477
+ },
45478
+ "resolution": null,
45479
+ "retry": {
45480
+ "preset": "retry-ffb3a9cb"
45481
+ },
45482
+ "errors": {
45483
+ "set": 0
45484
+ },
45485
+ "metadata": {
45486
+ "purpose": "Get the CompanyAlert field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
45487
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
45488
+ "preferredWhen": null,
45489
+ "related": [
45490
+ "company_alerts.getEntityInfo",
45491
+ "company_alerts.getUdfInfo"
45492
+ ],
45493
+ "untrustedFields": [
45494
+ "alertText"
45495
+ ]
45496
+ },
45497
+ "compact": null,
45498
+ "status": "tested"
45499
+ },
45500
+ {
45501
+ "id": "company_alerts.getUdfInfo",
45502
+ "resource": "company_alerts",
45503
+ "udfCapable": false,
45504
+ "operation": "getUdfInfo",
45505
+ "kind": "primitive",
45506
+ "endpoint": "GET /V1.0/CompanyAlerts/entityInformation/userDefinedFields",
45507
+ "effect": "read",
45508
+ "flags": [],
45509
+ "dryRun": false,
45510
+ "envelope": "UserDefinedFieldInformationResultModel",
45511
+ "inputSchema": {},
45512
+ "inputSchemaStrict": true,
45513
+ "outputSchema": {
45514
+ "type": "UserDefinedFieldInformationResultModel",
45515
+ "drops": []
45516
+ },
45517
+ "examples": [
45518
+ "await client.companyAlerts.getUdfInfo()"
45519
+ ],
45520
+ "permissions": "unknown",
45521
+ "pagination": {
45522
+ "mode": "none"
45523
+ },
45524
+ "resolution": null,
45525
+ "retry": {
45526
+ "preset": "retry-ffb3a9cb"
45527
+ },
45528
+ "errors": {
45529
+ "set": 0
45530
+ },
45531
+ "metadata": {
45532
+ "purpose": "Get the CompanyAlert user-defined-field catalog.",
45533
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
45534
+ "preferredWhen": null,
45535
+ "related": [
45536
+ "company_alerts.getFieldInfo"
45537
+ ],
45538
+ "untrustedFields": [
45539
+ "alertText"
45540
+ ]
45541
+ },
45542
+ "compact": null,
45543
+ "status": "tested"
45544
+ },
45545
+ {
45546
+ "id": "company_alerts.query",
45547
+ "resource": "company_alerts",
45548
+ "udfCapable": false,
45549
+ "operation": "query",
45550
+ "kind": "primitive",
45551
+ "endpoint": "GET|POST /V1.0/CompanyAlerts/query",
45552
+ "effect": "read",
45553
+ "flags": [],
45554
+ "dryRun": false,
45555
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
45556
+ "inputSchema": {
45557
+ "params": {
45558
+ "type": "object",
45559
+ "required": false,
45560
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
45561
+ "properties": [
45562
+ {
45563
+ "name": "filter",
45564
+ "type": "FilterCondition[]",
45565
+ "optional": true
45566
+ },
45567
+ {
45568
+ "name": "limit",
45569
+ "type": "number",
45570
+ "optional": true,
45571
+ "default": 500
45572
+ },
45573
+ {
45574
+ "name": "latest",
45575
+ "type": "number",
45576
+ "optional": true
45577
+ },
45578
+ {
45579
+ "name": "noteChars",
45580
+ "type": "number",
45581
+ "optional": true
45582
+ },
45583
+ {
45584
+ "name": "includeFields",
45585
+ "type": "string[]",
45586
+ "optional": true
45587
+ },
45588
+ {
45589
+ "name": "fieldCheck",
45590
+ "type": "boolean",
45591
+ "optional": true,
45592
+ "default": true
45593
+ },
45594
+ {
45595
+ "name": "names",
45596
+ "type": "boolean",
45597
+ "optional": true
45598
+ },
45599
+ {
45600
+ "name": "via",
45601
+ "type": "\"post\" | \"get\"",
45602
+ "optional": true
45603
+ },
45604
+ {
45605
+ "name": "acknowledgeUnscoped",
45606
+ "type": "boolean",
45607
+ "optional": true
45608
+ },
45609
+ {
45610
+ "name": "walk",
45611
+ "type": "object",
45612
+ "optional": true
45613
+ }
45614
+ ]
45615
+ }
45616
+ },
45617
+ "inputSchemaStrict": true,
45618
+ "outputSchema": {
45619
+ "type": "QueryActionResult[<Model>,<Entity>]",
45620
+ "drops": []
45621
+ },
45622
+ "examples": [
45623
+ "await client.companyAlerts.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
45624
+ ],
45625
+ "permissions": "unknown",
45626
+ "pagination": {
45627
+ "mode": "cursor",
45628
+ "vendorDefault": 10,
45629
+ "vendorMax": 500,
45630
+ "pageGuard": 1000,
45631
+ "queryBounded": {
45632
+ "default": 500,
45633
+ "max": 2500
45634
+ }
45635
+ },
45636
+ "resolution": null,
45637
+ "retry": {
45638
+ "preset": "retry-ffb3a9cb"
45639
+ },
45640
+ "errors": {
45641
+ "set": 4
45642
+ },
45643
+ "metadata": {
45644
+ "purpose": "Query CompanyAlert records with a JSON filter.",
45645
+ "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with companyID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
45646
+ "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
45647
+ "related": [
45648
+ "company_alerts.resolve"
45649
+ ],
45650
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
45651
+ "untrustedFields": [
45652
+ "alertText"
45653
+ ]
45654
+ },
45655
+ "compact": null,
45656
+ "status": "tested"
45657
+ },
45658
+ {
45659
+ "id": "company_alerts.resolve",
45660
+ "resource": "company_alerts",
45661
+ "udfCapable": false,
45662
+ "operation": "resolve",
45663
+ "kind": "helper",
45664
+ "endpoint": null,
45665
+ "effect": "read",
45666
+ "flags": [],
45667
+ "dryRun": false,
45668
+ "envelope": null,
45669
+ "inputSchema": {
45670
+ "identifier": {
45671
+ "type": "string | number",
45672
+ "required": true,
45673
+ "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
45674
+ },
45675
+ "opts": {
45676
+ "type": "object",
45677
+ "required": false,
45678
+ "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
45679
+ "properties": [
45680
+ {
45681
+ "name": "expand",
45682
+ "type": "boolean",
45683
+ "optional": true
45684
+ }
45685
+ ]
45686
+ }
45687
+ },
45688
+ "inputSchemaStrict": true,
45689
+ "outputSchema": {
45690
+ "type": "CompanyAlertSummary",
45691
+ "drops": []
45692
+ },
45693
+ "examples": [
45694
+ "await client.companyAlerts.resolve('example-value')"
45695
+ ],
45696
+ "permissions": "unknown",
45697
+ "pagination": {
45698
+ "mode": "none"
45699
+ },
45700
+ "resolution": {
45701
+ "basis": "server-filter",
45702
+ "maxScanRecords": 500,
45703
+ "maxScanPages": 4
45704
+ },
45705
+ "retry": {
45706
+ "preset": "retry-ffb3a9cb"
45707
+ },
45708
+ "errors": {
45709
+ "set": 5
45710
+ },
45711
+ "metadata": {
45712
+ "purpose": "Resolve a company alert from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
45713
+ "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
45714
+ "preferredWhen": null,
45715
+ "related": [
45716
+ "company_alerts.get"
45717
+ ],
45718
+ "untrustedFields": [
45719
+ "alertText"
45720
+ ]
45721
+ },
45722
+ "compact": "CompanyAlertSummary",
45723
+ "status": "tested"
45724
+ },
45725
+ {
45726
+ "id": "company_alerts.update",
45727
+ "resource": "company_alerts",
45728
+ "udfCapable": false,
45729
+ "operation": "update",
45730
+ "kind": "primitive",
45731
+ "endpoint": "PUT|PATCH /V1.0/Companies/{parentId}/Alerts",
45732
+ "effect": "write",
45733
+ "flags": [
45734
+ "idempotent"
45735
+ ],
45736
+ "dryRun": true,
45737
+ "envelope": "OperationResultModel",
45738
+ "inputSchema": {
45739
+ "parentId": {
45740
+ "type": "string | number",
45741
+ "required": true,
45742
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45743
+ },
45744
+ "id": {
45745
+ "type": "string | number",
45746
+ "required": true,
45747
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
45748
+ },
45749
+ "data": {
45750
+ "type": "object",
45751
+ "required": true,
45752
+ "description": "The record payload (vendor model fields)."
45753
+ }
45754
+ },
45755
+ "inputSchemaStrict": true,
45756
+ "outputSchema": {
45757
+ "type": "OperationResultModel",
45758
+ "drops": []
45759
+ },
45760
+ "examples": [
45761
+ "await client.companyAlerts.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
45762
+ ],
45763
+ "permissions": "unknown",
45764
+ "pagination": {
45765
+ "mode": "none"
45766
+ },
45767
+ "resolution": null,
45768
+ "retry": {
45769
+ "preset": "retry-85897a3a"
45770
+ },
45771
+ "errors": {
45772
+ "set": 1
45773
+ },
45774
+ "metadata": {
45775
+ "purpose": "Update a company alert.",
45776
+ "usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id.",
45777
+ "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
45778
+ "related": [
45779
+ "company_alerts.get"
45780
+ ],
45781
+ "untrustedFields": [
45782
+ "alertText"
45783
+ ]
45784
+ },
45785
+ "compact": null,
45786
+ "status": "tested"
45787
+ },
45788
+ {
45789
+ "id": "company_attachments.count",
45790
+ "resource": "company_attachments",
45791
+ "udfCapable": false,
45792
+ "operation": "count",
45793
+ "kind": "primitive",
45794
+ "endpoint": "GET|POST /V1.0/CompanyAttachments/query/count",
45795
+ "effect": "read",
45796
+ "flags": [],
45797
+ "dryRun": false,
45798
+ "envelope": "QueryCountResultModel",
45799
+ "inputSchema": {
45800
+ "params": {
45801
+ "type": "object",
45802
+ "required": false,
45803
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
45804
+ "properties": [
45805
+ {
45806
+ "name": "filter",
45807
+ "type": "FilterCondition[]",
45808
+ "optional": true
45809
+ },
45810
+ {
45811
+ "name": "fieldCheck",
45812
+ "type": "boolean",
45813
+ "optional": true
45814
+ }
45815
+ ]
45816
+ }
45817
+ },
45818
+ "inputSchemaStrict": true,
45819
+ "outputSchema": {
45820
+ "type": "QueryCountResultModel",
45821
+ "drops": []
45822
+ },
45823
+ "examples": [
45824
+ "await client.companyAttachments.count({ filter: [{ field: 'companyID', op: 'eq', value: 1 }] })"
45825
+ ],
45826
+ "permissions": "unknown",
45827
+ "pagination": {
45828
+ "mode": "none"
45829
+ },
45830
+ "resolution": null,
45831
+ "retry": {
45832
+ "preset": "retry-ffb3a9cb"
45833
+ },
45834
+ "errors": {
45835
+ "set": 0
45836
+ },
45837
+ "metadata": {
45838
+ "purpose": "Count attachment records matching a JSON filter. (under a company)",
45839
+ "usage": "Unwraps queryCount; returns a plain number. Filter by companyID for company scope. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility.",
45840
+ "preferredWhen": null,
45841
+ "related": [
45842
+ "company_attachments.query"
45843
+ ],
45844
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
45845
+ "untrustedFields": [
45846
+ "title"
45847
+ ]
45848
+ },
45849
+ "compact": null,
45850
+ "status": "tested"
45851
+ },
45852
+ {
45853
+ "id": "company_attachments.create",
45854
+ "resource": "company_attachments",
45855
+ "udfCapable": false,
45856
+ "operation": "create",
45857
+ "kind": "primitive",
45858
+ "endpoint": "POST /V1.0/Companies/{parentId}/Attachments",
45859
+ "effect": "write",
45860
+ "flags": [],
45861
+ "dryRun": true,
45862
+ "envelope": "OperationResultModel",
45863
+ "inputSchema": {
45864
+ "parentId": {
45865
+ "type": "string | number",
45866
+ "required": true,
45867
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45868
+ },
45869
+ "data": {
45870
+ "type": "object",
45871
+ "required": true,
45872
+ "description": "The record payload (vendor model fields)."
45873
+ }
45874
+ },
45875
+ "inputSchemaStrict": true,
45876
+ "outputSchema": {
45877
+ "type": "OperationResultModel",
45878
+ "drops": []
45879
+ },
45880
+ "examples": [
45881
+ "await client.companyAttachments.create(1, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: 1, data: 'bm90ZQ==' }, { dryRun: true })"
45882
+ ],
45883
+ "permissions": "unknown",
45884
+ "pagination": {
45885
+ "mode": "none"
45886
+ },
45887
+ "resolution": null,
45888
+ "retry": {
45889
+ "preset": "retry-c5657094"
45890
+ },
45891
+ "errors": {
45892
+ "set": 1
45893
+ },
45894
+ "metadata": {
45895
+ "purpose": "Create an attachment. (under a company)",
45896
+ "usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. FILE_ATTACHMENT requires base64 data; use current attachmentType/publish metadata and vendor file limits. ParentId addresses the Companies record. Permission and impersonation restrictions apply.",
45897
+ "preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
45898
+ "related": [
45899
+ "company_attachments.get"
45900
+ ],
45901
+ "untrustedFields": [
45902
+ "title"
45903
+ ],
45904
+ "createRequirements": {
45905
+ "requiresByValue": [
45906
+ {
45907
+ "field": "attachmentType",
45908
+ "value": "FILE_ATTACHMENT",
45909
+ "requires": {
45910
+ "allOf": [
45911
+ "data"
45912
+ ]
45913
+ }
45914
+ }
45915
+ ]
45916
+ }
45917
+ },
45918
+ "compact": null,
45919
+ "status": "tested"
45920
+ },
45921
+ {
45922
+ "id": "company_attachments.delete",
45923
+ "resource": "company_attachments",
45924
+ "udfCapable": false,
45925
+ "operation": "delete",
45926
+ "kind": "primitive",
45927
+ "endpoint": "DELETE /V1.0/Companies/{parentId}/Attachments/{id}",
45928
+ "effect": "destructive",
45929
+ "flags": [
45930
+ "idempotent",
45931
+ "requiresApproval"
45932
+ ],
45933
+ "dryRun": true,
45934
+ "envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
45935
+ "inputSchema": {
45936
+ "parentId": {
45937
+ "type": "string | number",
45938
+ "required": true,
45939
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45940
+ },
45941
+ "id": {
45942
+ "type": "string | number",
45943
+ "required": true,
45944
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
45945
+ }
45946
+ },
45947
+ "inputSchemaStrict": true,
45948
+ "outputSchema": {
45949
+ "type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
45950
+ "drops": []
45951
+ },
45952
+ "examples": [
45953
+ "await invoke(client, 'company_attachments.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_attachments.delete' })"
45954
+ ],
45955
+ "permissions": "unknown",
45956
+ "pagination": {
45957
+ "mode": "none"
45958
+ },
45959
+ "resolution": null,
45960
+ "retry": {
45961
+ "preset": "retry-1849870d"
45962
+ },
45963
+ "errors": {
45964
+ "set": 2
45965
+ },
45966
+ "metadata": {
45967
+ "purpose": "Delete an attachment. (under a company)",
45968
+ "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
45969
+ "preferredWhen": null,
45970
+ "related": [
45971
+ "company_attachments.get"
45972
+ ],
45973
+ "untrustedFields": [
45974
+ "title"
45975
+ ]
45976
+ },
45977
+ "compact": null,
45978
+ "status": "tested"
45979
+ },
45980
+ {
45981
+ "id": "company_attachments.get",
45982
+ "resource": "company_attachments",
45983
+ "udfCapable": false,
45984
+ "operation": "get",
45985
+ "kind": "primitive",
45986
+ "endpoint": "GET /V1.0/Companies/{parentId}/Attachments/{id}",
45987
+ "effect": "read",
45988
+ "flags": [],
45989
+ "dryRun": false,
45990
+ "envelope": "CompanyAttachmentModel",
45991
+ "inputSchema": {
45992
+ "parentId": {
45993
+ "type": "string | number",
45994
+ "required": true,
45995
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
45996
+ },
45997
+ "id": {
45998
+ "type": "string | number",
45999
+ "required": true,
46000
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
46001
+ },
46002
+ "opts": {
46003
+ "type": "object",
46004
+ "required": false,
46005
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
46006
+ "properties": [
46007
+ {
46008
+ "name": "fresh",
46009
+ "type": "boolean",
46010
+ "optional": true
46011
+ }
46012
+ ]
46013
+ }
46014
+ },
46015
+ "inputSchemaStrict": true,
46016
+ "outputSchema": {
46017
+ "type": "CompanyAttachmentModel",
46018
+ "drops": []
46019
+ },
46020
+ "examples": [
46021
+ "await client.companyAttachments.get('example-value', 'example-value')"
46022
+ ],
46023
+ "permissions": "unknown",
46024
+ "pagination": {
46025
+ "mode": "none"
46026
+ },
46027
+ "resolution": null,
46028
+ "retry": {
46029
+ "preset": "retry-ffb3a9cb"
46030
+ },
46031
+ "errors": {
46032
+ "set": 3
46033
+ },
46034
+ "metadata": {
46035
+ "purpose": "Get one CompanyAttachment by id.",
46036
+ "usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the company id, followed by the attachment id.",
46037
+ "preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
46038
+ "related": [
46039
+ "company_attachments.query"
46040
+ ],
46041
+ "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a company_attachments.query with includeFields.",
46042
+ "untrustedFields": [
46043
+ "title"
46044
+ ]
46045
+ },
46046
+ "compact": null,
46047
+ "status": "tested"
46048
+ },
46049
+ {
46050
+ "id": "company_attachments.getEntityInfo",
46051
+ "resource": "company_attachments",
46052
+ "udfCapable": false,
46053
+ "operation": "getEntityInfo",
46054
+ "kind": "primitive",
46055
+ "endpoint": "GET /V1.0/CompanyAttachments/entityInformation",
46056
+ "effect": "read",
46057
+ "flags": [],
46058
+ "dryRun": false,
46059
+ "envelope": "EntityInformationResultModel",
46060
+ "inputSchema": {},
46061
+ "inputSchemaStrict": true,
46062
+ "outputSchema": {
46063
+ "type": "EntityInformationResultModel",
46064
+ "drops": []
46065
+ },
46066
+ "examples": [
46067
+ "await client.companyAttachments.getEntityInfo()"
46068
+ ],
46069
+ "permissions": "unknown",
46070
+ "pagination": {
46071
+ "mode": "none"
46072
+ },
46073
+ "resolution": null,
46074
+ "retry": {
46075
+ "preset": "retry-ffb3a9cb"
46076
+ },
46077
+ "errors": {
46078
+ "set": 0
46079
+ },
46080
+ "metadata": {
46081
+ "purpose": "Get the CompanyAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
46082
+ "usage": "Unwraps info{}; drives client-side capability checks.",
46083
+ "preferredWhen": null,
46084
+ "related": [
46085
+ "company_attachments.getFieldInfo"
46086
+ ],
46087
+ "untrustedFields": [
46088
+ "title"
46089
+ ]
46090
+ },
46091
+ "compact": null,
46092
+ "status": "tested"
46093
+ },
46094
+ {
46095
+ "id": "company_attachments.getFieldInfo",
46096
+ "resource": "company_attachments",
46097
+ "udfCapable": false,
46098
+ "operation": "getFieldInfo",
46099
+ "kind": "primitive",
46100
+ "endpoint": "GET /V1.0/CompanyAttachments/entityInformation/fields",
46101
+ "effect": "read",
46102
+ "flags": [],
46103
+ "dryRun": false,
46104
+ "envelope": "FieldInformationResultModel",
46105
+ "inputSchema": {},
46106
+ "inputSchemaStrict": true,
46107
+ "outputSchema": {
46108
+ "type": "FieldInformationResultModel",
46109
+ "drops": []
46110
+ },
46111
+ "examples": [
46112
+ "await client.companyAttachments.getFieldInfo()"
46113
+ ],
46114
+ "permissions": "unknown",
46115
+ "pagination": {
46116
+ "mode": "none"
46117
+ },
46118
+ "resolution": null,
46119
+ "retry": {
46120
+ "preset": "retry-ffb3a9cb"
46121
+ },
46122
+ "errors": {
46123
+ "set": 0
46124
+ },
46125
+ "metadata": {
46126
+ "purpose": "Get the CompanyAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
46127
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
46128
+ "preferredWhen": null,
46129
+ "related": [
46130
+ "company_attachments.getEntityInfo"
46131
+ ],
46132
+ "untrustedFields": [
46133
+ "title"
46134
+ ]
46135
+ },
46136
+ "compact": null,
46137
+ "status": "tested"
46138
+ },
46139
+ {
46140
+ "id": "company_attachments.query",
46141
+ "resource": "company_attachments",
46142
+ "udfCapable": false,
46143
+ "operation": "query",
46144
+ "kind": "primitive",
46145
+ "endpoint": "GET|POST /V1.0/CompanyAttachments/query",
46146
+ "effect": "read",
46147
+ "flags": [],
46148
+ "dryRun": false,
46149
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
46150
+ "inputSchema": {
46151
+ "params": {
46152
+ "type": "object",
46153
+ "required": false,
46154
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
46155
+ "properties": [
46156
+ {
46157
+ "name": "filter",
46158
+ "type": "FilterCondition[]",
46159
+ "optional": true
46160
+ },
46161
+ {
46162
+ "name": "limit",
46163
+ "type": "number",
46164
+ "optional": true,
46165
+ "default": 500
46166
+ },
46167
+ {
46168
+ "name": "latest",
46169
+ "type": "number",
46170
+ "optional": true
46171
+ },
46172
+ {
46173
+ "name": "noteChars",
46174
+ "type": "number",
46175
+ "optional": true
46176
+ },
46177
+ {
46178
+ "name": "includeFields",
46179
+ "type": "string[]",
46180
+ "optional": true
46181
+ },
46182
+ {
46183
+ "name": "fieldCheck",
46184
+ "type": "boolean",
46185
+ "optional": true,
46186
+ "default": true
46187
+ },
46188
+ {
46189
+ "name": "names",
46190
+ "type": "boolean",
46191
+ "optional": true
46192
+ },
46193
+ {
46194
+ "name": "via",
46195
+ "type": "\"post\" | \"get\"",
46196
+ "optional": true
46197
+ },
46198
+ {
46199
+ "name": "acknowledgeUnscoped",
46200
+ "type": "boolean",
46201
+ "optional": true
46202
+ },
46203
+ {
46204
+ "name": "walk",
46205
+ "type": "object",
46206
+ "optional": true
46207
+ }
46208
+ ]
46209
+ }
46210
+ },
46211
+ "inputSchemaStrict": true,
46212
+ "outputSchema": {
46213
+ "type": "QueryActionResult[<Model>,<Entity>]",
46214
+ "drops": []
46215
+ },
46216
+ "examples": [
46217
+ "await client.companyAttachments.query({ filter: [{ field: 'companyID', op: 'eq', value: 1 }], limit: 25 })"
46218
+ ],
46219
+ "permissions": "unknown",
46220
+ "pagination": {
46221
+ "mode": "cursor",
46222
+ "vendorDefault": 10,
46223
+ "vendorMax": 500,
46224
+ "pageGuard": 1000,
46225
+ "queryBounded": {
46226
+ "default": 500,
46227
+ "max": 2500
46228
+ }
46229
+ },
46230
+ "resolution": null,
46231
+ "retry": {
46232
+ "preset": "retry-ffb3a9cb"
46233
+ },
46234
+ "errors": {
46235
+ "set": 4
46236
+ },
46237
+ "metadata": {
46238
+ "purpose": "Query CompanyAttachment records with a JSON filter.",
46239
+ "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with companyID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Filter by companyID for company scope. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
46240
+ "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
46241
+ "related": [
46242
+ "company_attachments.get"
46243
+ ],
46244
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
46245
+ "untrustedFields": [
46246
+ "title"
46247
+ ]
46248
+ },
46249
+ "compact": null,
46250
+ "status": "tested"
46251
+ },
46252
+ {
46253
+ "id": "company_locations.count",
46254
+ "resource": "company_locations",
46255
+ "udfCapable": false,
46256
+ "operation": "count",
46257
+ "kind": "primitive",
46258
+ "endpoint": "GET|POST /V1.0/CompanyLocations/query/count",
46259
+ "effect": "read",
46260
+ "flags": [],
46261
+ "dryRun": false,
46262
+ "envelope": "QueryCountResultModel",
46263
+ "inputSchema": {
46264
+ "params": {
46265
+ "type": "object",
46266
+ "required": false,
46267
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
46268
+ "properties": [
46269
+ {
46270
+ "name": "filter",
46271
+ "type": "FilterCondition[]",
46272
+ "optional": true
46273
+ },
46274
+ {
46275
+ "name": "fieldCheck",
46276
+ "type": "boolean",
46277
+ "optional": true
46278
+ }
46279
+ ]
46280
+ }
46281
+ },
46282
+ "inputSchemaStrict": true,
46283
+ "outputSchema": {
46284
+ "type": "QueryCountResultModel",
46285
+ "drops": []
46286
+ },
46287
+ "examples": [
46288
+ "await client.companyLocations.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
46289
+ ],
46290
+ "permissions": "unknown",
46291
+ "pagination": {
46292
+ "mode": "none"
46293
+ },
46294
+ "resolution": null,
46295
+ "retry": {
46296
+ "preset": "retry-ffb3a9cb"
46297
+ },
46298
+ "errors": {
46299
+ "set": 0
46300
+ },
46301
+ "metadata": {
46302
+ "purpose": "Count company location records matching a JSON filter.",
46303
+ "usage": "Unwraps queryCount; returns a plain number.",
46304
+ "preferredWhen": null,
46305
+ "related": [
46306
+ "company_locations.query"
46307
+ ],
46308
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
46309
+ "untrustedFields": [
46310
+ "description",
46311
+ "name"
46312
+ ]
46313
+ },
46314
+ "compact": null,
46315
+ "status": "tested"
46316
+ },
46317
+ {
46318
+ "id": "company_locations.create",
46319
+ "resource": "company_locations",
46320
+ "udfCapable": false,
46321
+ "operation": "create",
46322
+ "kind": "primitive",
46323
+ "endpoint": "POST /V1.0/Companies/{parentId}/Locations",
46324
+ "effect": "write",
46325
+ "flags": [],
46326
+ "dryRun": true,
46327
+ "envelope": "OperationResultModel",
46328
+ "inputSchema": {
46329
+ "parentId": {
46330
+ "type": "string | number",
46331
+ "required": true,
46332
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
46333
+ },
46334
+ "data": {
46335
+ "type": "object",
46336
+ "required": true,
46337
+ "description": "The record payload (vendor model fields)."
46338
+ }
46339
+ },
46340
+ "inputSchemaStrict": true,
46341
+ "outputSchema": {
46342
+ "type": "OperationResultModel",
46343
+ "drops": []
46344
+ },
46345
+ "examples": [
46346
+ "await client.companyLocations.create('example-value', { name: 'example' }, { dryRun: true })"
44878
46347
  ],
44879
46348
  "permissions": "unknown",
44880
46349
  "pagination": {
@@ -44888,26 +46357,27 @@ const CAPABILITY_DATA = {
44888
46357
  "set": 1
44889
46358
  },
44890
46359
  "metadata": {
44891
- "purpose": "Create a company alert.",
46360
+ "purpose": "Create a company location.",
44892
46361
  "usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
44893
46362
  "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
44894
46363
  "related": [
44895
- "company_alerts.update"
46364
+ "company_locations.update"
44896
46365
  ],
44897
46366
  "untrustedFields": [
44898
- "alertText"
46367
+ "description",
46368
+ "name"
44899
46369
  ]
44900
46370
  },
44901
46371
  "compact": null,
44902
46372
  "status": "tested"
44903
46373
  },
44904
46374
  {
44905
- "id": "company_alerts.delete",
44906
- "resource": "company_alerts",
46375
+ "id": "company_locations.delete",
46376
+ "resource": "company_locations",
44907
46377
  "udfCapable": false,
44908
46378
  "operation": "delete",
44909
46379
  "kind": "primitive",
44910
- "endpoint": "DELETE /V1.0/Companies/{parentId}/Alerts/{id}",
46380
+ "endpoint": "DELETE /V1.0/Companies/{parentId}/Locations/{id}",
44911
46381
  "effect": "destructive",
44912
46382
  "flags": [
44913
46383
  "idempotent",
@@ -44933,7 +46403,7 @@ const CAPABILITY_DATA = {
44933
46403
  "drops": []
44934
46404
  },
44935
46405
  "examples": [
44936
- "await invoke(client, 'company_alerts.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_alerts.delete' })"
46406
+ "await invoke(client, 'company_locations.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_locations.delete' })"
44937
46407
  ],
44938
46408
  "permissions": "unknown",
44939
46409
  "pagination": {
@@ -44947,30 +46417,31 @@ const CAPABILITY_DATA = {
44947
46417
  "set": 2
44948
46418
  },
44949
46419
  "metadata": {
44950
- "purpose": "Delete a company alert.",
46420
+ "purpose": "Delete a company location.",
44951
46421
  "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
44952
46422
  "preferredWhen": null,
44953
46423
  "related": [
44954
- "company_alerts.get"
46424
+ "company_locations.get"
44955
46425
  ],
44956
46426
  "untrustedFields": [
44957
- "alertText"
46427
+ "description",
46428
+ "name"
44958
46429
  ]
44959
46430
  },
44960
46431
  "compact": null,
44961
46432
  "status": "tested"
44962
46433
  },
44963
46434
  {
44964
- "id": "company_alerts.get",
44965
- "resource": "company_alerts",
46435
+ "id": "company_locations.get",
46436
+ "resource": "company_locations",
44966
46437
  "udfCapable": false,
44967
46438
  "operation": "get",
44968
46439
  "kind": "primitive",
44969
- "endpoint": "GET /V1.0/Companies/{parentId}/Alerts/{id}",
46440
+ "endpoint": "GET /V1.0/Companies/{parentId}/Locations/{id}",
44970
46441
  "effect": "read",
44971
46442
  "flags": [],
44972
46443
  "dryRun": false,
44973
- "envelope": "ItemQueryResultModel[CompanyAlertModel,AccountAlert]",
46444
+ "envelope": "ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]",
44974
46445
  "inputSchema": {
44975
46446
  "parentId": {
44976
46447
  "type": "string | number",
@@ -44997,11 +46468,11 @@ const CAPABILITY_DATA = {
44997
46468
  },
44998
46469
  "inputSchemaStrict": true,
44999
46470
  "outputSchema": {
45000
- "type": "ItemQueryResultModel[CompanyAlertModel,AccountAlert]",
46471
+ "type": "ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]",
45001
46472
  "drops": []
45002
46473
  },
45003
46474
  "examples": [
45004
- "await client.companyAlerts.get('example-value', 'example-value')"
46475
+ "await client.companyLocations.get('example-value', 'example-value')"
45005
46476
  ],
45006
46477
  "permissions": "unknown",
45007
46478
  "pagination": {
@@ -45015,27 +46486,28 @@ const CAPABILITY_DATA = {
45015
46486
  "set": 3
45016
46487
  },
45017
46488
  "metadata": {
45018
- "purpose": "Get one CompanyAlert by id.",
46489
+ "purpose": "Get one CompanyLocation by id.",
45019
46490
  "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
45020
- "preferredWhen": "Preferred when the numeric id is already known; company_alerts.resolve is for a field value.",
46491
+ "preferredWhen": "Preferred when the numeric id is already known; company_locations.resolve is for a field value.",
45021
46492
  "related": [
45022
- "company_alerts.resolve"
46493
+ "company_locations.resolve"
45023
46494
  ],
45024
- "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a company_alerts.query with includeFields.",
46495
+ "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use company_locations.search (compact summary) or a company_locations.query with includeFields.",
45025
46496
  "untrustedFields": [
45026
- "alertText"
46497
+ "description",
46498
+ "name"
45027
46499
  ]
45028
46500
  },
45029
46501
  "compact": null,
45030
46502
  "status": "tested"
45031
46503
  },
45032
46504
  {
45033
- "id": "company_alerts.getEntityInfo",
45034
- "resource": "company_alerts",
46505
+ "id": "company_locations.getEntityInfo",
46506
+ "resource": "company_locations",
45035
46507
  "udfCapable": false,
45036
46508
  "operation": "getEntityInfo",
45037
46509
  "kind": "primitive",
45038
- "endpoint": "GET /V1.0/CompanyAlerts/entityInformation",
46510
+ "endpoint": "GET /V1.0/CompanyLocations/entityInformation",
45039
46511
  "effect": "read",
45040
46512
  "flags": [],
45041
46513
  "dryRun": false,
@@ -45047,7 +46519,7 @@ const CAPABILITY_DATA = {
45047
46519
  "drops": []
45048
46520
  },
45049
46521
  "examples": [
45050
- "await client.companyAlerts.getEntityInfo()"
46522
+ "await client.companyLocations.getEntityInfo()"
45051
46523
  ],
45052
46524
  "permissions": "unknown",
45053
46525
  "pagination": {
@@ -45061,26 +46533,27 @@ const CAPABILITY_DATA = {
45061
46533
  "set": 0
45062
46534
  },
45063
46535
  "metadata": {
45064
- "purpose": "Get the CompanyAlert capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
46536
+ "purpose": "Get the CompanyLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
45065
46537
  "usage": "Unwraps info{}; drives client-side capability checks.",
45066
46538
  "preferredWhen": null,
45067
46539
  "related": [
45068
- "company_alerts.getFieldInfo"
46540
+ "company_locations.getFieldInfo"
45069
46541
  ],
45070
46542
  "untrustedFields": [
45071
- "alertText"
46543
+ "description",
46544
+ "name"
45072
46545
  ]
45073
46546
  },
45074
46547
  "compact": null,
45075
46548
  "status": "tested"
45076
46549
  },
45077
46550
  {
45078
- "id": "company_alerts.getFieldInfo",
45079
- "resource": "company_alerts",
46551
+ "id": "company_locations.getFieldInfo",
46552
+ "resource": "company_locations",
45080
46553
  "udfCapable": false,
45081
46554
  "operation": "getFieldInfo",
45082
46555
  "kind": "primitive",
45083
- "endpoint": "GET /V1.0/CompanyAlerts/entityInformation/fields",
46556
+ "endpoint": "GET /V1.0/CompanyLocations/entityInformation/fields",
45084
46557
  "effect": "read",
45085
46558
  "flags": [],
45086
46559
  "dryRun": false,
@@ -45092,7 +46565,7 @@ const CAPABILITY_DATA = {
45092
46565
  "drops": []
45093
46566
  },
45094
46567
  "examples": [
45095
- "await client.companyAlerts.getFieldInfo()"
46568
+ "await client.companyLocations.getFieldInfo()"
45096
46569
  ],
45097
46570
  "permissions": "unknown",
45098
46571
  "pagination": {
@@ -45106,27 +46579,28 @@ const CAPABILITY_DATA = {
45106
46579
  "set": 0
45107
46580
  },
45108
46581
  "metadata": {
45109
- "purpose": "Get the CompanyAlert field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
46582
+ "purpose": "Get the CompanyLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
45110
46583
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
45111
46584
  "preferredWhen": null,
45112
46585
  "related": [
45113
- "company_alerts.getEntityInfo",
45114
- "company_alerts.getUdfInfo"
46586
+ "company_locations.getEntityInfo",
46587
+ "company_locations.getUdfInfo"
45115
46588
  ],
45116
46589
  "untrustedFields": [
45117
- "alertText"
46590
+ "description",
46591
+ "name"
45118
46592
  ]
45119
46593
  },
45120
46594
  "compact": null,
45121
46595
  "status": "tested"
45122
46596
  },
45123
46597
  {
45124
- "id": "company_alerts.getUdfInfo",
45125
- "resource": "company_alerts",
46598
+ "id": "company_locations.getUdfInfo",
46599
+ "resource": "company_locations",
45126
46600
  "udfCapable": false,
45127
46601
  "operation": "getUdfInfo",
45128
46602
  "kind": "primitive",
45129
- "endpoint": "GET /V1.0/CompanyAlerts/entityInformation/userDefinedFields",
46603
+ "endpoint": "GET /V1.0/CompanyLocations/entityInformation/userDefinedFields",
45130
46604
  "effect": "read",
45131
46605
  "flags": [],
45132
46606
  "dryRun": false,
@@ -45138,7 +46612,7 @@ const CAPABILITY_DATA = {
45138
46612
  "drops": []
45139
46613
  },
45140
46614
  "examples": [
45141
- "await client.companyAlerts.getUdfInfo()"
46615
+ "await client.companyLocations.getUdfInfo()"
45142
46616
  ],
45143
46617
  "permissions": "unknown",
45144
46618
  "pagination": {
@@ -45152,26 +46626,27 @@ const CAPABILITY_DATA = {
45152
46626
  "set": 0
45153
46627
  },
45154
46628
  "metadata": {
45155
- "purpose": "Get the CompanyAlert user-defined-field catalog.",
46629
+ "purpose": "Get the CompanyLocation user-defined-field catalog.",
45156
46630
  "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
45157
46631
  "preferredWhen": null,
45158
46632
  "related": [
45159
- "company_alerts.getFieldInfo"
46633
+ "company_locations.getFieldInfo"
45160
46634
  ],
45161
46635
  "untrustedFields": [
45162
- "alertText"
46636
+ "description",
46637
+ "name"
45163
46638
  ]
45164
46639
  },
45165
46640
  "compact": null,
45166
46641
  "status": "tested"
45167
46642
  },
45168
46643
  {
45169
- "id": "company_alerts.query",
45170
- "resource": "company_alerts",
46644
+ "id": "company_locations.query",
46645
+ "resource": "company_locations",
45171
46646
  "udfCapable": false,
45172
46647
  "operation": "query",
45173
46648
  "kind": "primitive",
45174
- "endpoint": "GET|POST /V1.0/CompanyAlerts/query",
46649
+ "endpoint": "GET|POST /V1.0/CompanyLocations/query",
45175
46650
  "effect": "read",
45176
46651
  "flags": [],
45177
46652
  "dryRun": false,
@@ -45243,7 +46718,7 @@ const CAPABILITY_DATA = {
45243
46718
  "drops": []
45244
46719
  },
45245
46720
  "examples": [
45246
- "await client.companyAlerts.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
46721
+ "await client.companyLocations.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
45247
46722
  ],
45248
46723
  "permissions": "unknown",
45249
46724
  "pagination": {
@@ -45264,23 +46739,24 @@ const CAPABILITY_DATA = {
45264
46739
  "set": 4
45265
46740
  },
45266
46741
  "metadata": {
45267
- "purpose": "Query CompanyAlert records with a JSON filter.",
46742
+ "purpose": "Query CompanyLocation records with a JSON filter.",
45268
46743
  "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with companyID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
45269
46744
  "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
45270
46745
  "related": [
45271
- "company_alerts.resolve"
46746
+ "company_locations.resolve"
45272
46747
  ],
45273
- "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
46748
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer company_locations.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
45274
46749
  "untrustedFields": [
45275
- "alertText"
46750
+ "description",
46751
+ "name"
45276
46752
  ]
45277
46753
  },
45278
46754
  "compact": null,
45279
46755
  "status": "tested"
45280
46756
  },
45281
46757
  {
45282
- "id": "company_alerts.resolve",
45283
- "resource": "company_alerts",
46758
+ "id": "company_locations.resolve",
46759
+ "resource": "company_locations",
45284
46760
  "udfCapable": false,
45285
46761
  "operation": "resolve",
45286
46762
  "kind": "helper",
@@ -45310,11 +46786,11 @@ const CAPABILITY_DATA = {
45310
46786
  },
45311
46787
  "inputSchemaStrict": true,
45312
46788
  "outputSchema": {
45313
- "type": "CompanyAlertSummary",
46789
+ "type": "CompanyLocationSummary",
45314
46790
  "drops": []
45315
46791
  },
45316
46792
  "examples": [
45317
- "await client.companyAlerts.resolve('example-value')"
46793
+ "await client.companyLocations.resolve('example-value')"
45318
46794
  ],
45319
46795
  "permissions": "unknown",
45320
46796
  "pagination": {
@@ -45332,26 +46808,96 @@ const CAPABILITY_DATA = {
45332
46808
  "set": 5
45333
46809
  },
45334
46810
  "metadata": {
45335
- "purpose": "Resolve a company alert from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
46811
+ "purpose": "Resolve a company location from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Company location record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
45336
46812
  "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
45337
46813
  "preferredWhen": null,
45338
46814
  "related": [
45339
- "company_alerts.get"
46815
+ "company_locations.get"
45340
46816
  ],
45341
46817
  "untrustedFields": [
45342
- "alertText"
46818
+ "description",
46819
+ "name"
45343
46820
  ]
45344
46821
  },
45345
- "compact": "CompanyAlertSummary",
46822
+ "compact": "CompanyLocationSummary",
45346
46823
  "status": "tested"
45347
46824
  },
45348
46825
  {
45349
- "id": "company_alerts.update",
45350
- "resource": "company_alerts",
46826
+ "id": "company_locations.search",
46827
+ "resource": "company_locations",
46828
+ "udfCapable": false,
46829
+ "operation": "search",
46830
+ "kind": "helper",
46831
+ "endpoint": null,
46832
+ "effect": "read",
46833
+ "flags": [],
46834
+ "dryRun": false,
46835
+ "envelope": null,
46836
+ "inputSchema": {
46837
+ "query": {
46838
+ "type": "string",
46839
+ "required": true,
46840
+ "description": "The free text to match (contains) on the resource searchable fields."
46841
+ },
46842
+ "opts": {
46843
+ "type": "object",
46844
+ "required": false,
46845
+ "description": "SearchOpts — { limit?: number } (1-500, default 25).",
46846
+ "properties": [
46847
+ {
46848
+ "name": "limit",
46849
+ "type": "number",
46850
+ "optional": true
46851
+ }
46852
+ ]
46853
+ }
46854
+ },
46855
+ "inputSchemaStrict": true,
46856
+ "outputSchema": {
46857
+ "type": "CompanyLocationSummary",
46858
+ "drops": []
46859
+ },
46860
+ "examples": [
46861
+ "await client.companyLocations.search('example')"
46862
+ ],
46863
+ "permissions": "unknown",
46864
+ "pagination": {
46865
+ "mode": "none"
46866
+ },
46867
+ "resolution": {
46868
+ "basis": "server-filter",
46869
+ "maxScanRecords": 500,
46870
+ "maxScanPages": 4
46871
+ },
46872
+ "retry": {
46873
+ "preset": "retry-ffb3a9cb"
46874
+ },
46875
+ "errors": {
46876
+ "set": 5
46877
+ },
46878
+ "metadata": {
46879
+ "purpose": "Search company location records by text (contains on the searchable fields).",
46880
+ "usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
46881
+ "preferredWhen": null,
46882
+ "related": [
46883
+ "company_locations.resolve",
46884
+ "company_locations.query"
46885
+ ],
46886
+ "untrustedFields": [
46887
+ "description",
46888
+ "name"
46889
+ ]
46890
+ },
46891
+ "compact": "CompanyLocationSummary",
46892
+ "status": "tested"
46893
+ },
46894
+ {
46895
+ "id": "company_locations.update",
46896
+ "resource": "company_locations",
45351
46897
  "udfCapable": false,
45352
46898
  "operation": "update",
45353
46899
  "kind": "primitive",
45354
- "endpoint": "PUT|PATCH /V1.0/Companies/{parentId}/Alerts",
46900
+ "endpoint": "PUT|PATCH /V1.0/Companies/{parentId}/Locations",
45355
46901
  "effect": "write",
45356
46902
  "flags": [
45357
46903
  "idempotent"
@@ -45381,7 +46927,7 @@ const CAPABILITY_DATA = {
45381
46927
  "drops": []
45382
46928
  },
45383
46929
  "examples": [
45384
- "await client.companyAlerts.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
46930
+ "await client.companyLocations.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
45385
46931
  ],
45386
46932
  "permissions": "unknown",
45387
46933
  "pagination": {
@@ -45395,26 +46941,27 @@ const CAPABILITY_DATA = {
45395
46941
  "set": 1
45396
46942
  },
45397
46943
  "metadata": {
45398
- "purpose": "Update a company alert.",
46944
+ "purpose": "Update a company location.",
45399
46945
  "usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id.",
45400
46946
  "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
45401
46947
  "related": [
45402
- "company_alerts.get"
46948
+ "company_locations.get"
45403
46949
  ],
45404
46950
  "untrustedFields": [
45405
- "alertText"
46951
+ "description",
46952
+ "name"
45406
46953
  ]
45407
46954
  },
45408
46955
  "compact": null,
45409
46956
  "status": "tested"
45410
46957
  },
45411
46958
  {
45412
- "id": "company_locations.count",
45413
- "resource": "company_locations",
46959
+ "id": "company_note_attachments.count",
46960
+ "resource": "company_note_attachments",
45414
46961
  "udfCapable": false,
45415
46962
  "operation": "count",
45416
46963
  "kind": "primitive",
45417
- "endpoint": "GET|POST /V1.0/CompanyLocations/query/count",
46964
+ "endpoint": "GET|POST /V1.0/CompanyNoteAttachments/query/count",
45418
46965
  "effect": "read",
45419
46966
  "flags": [],
45420
46967
  "dryRun": false,
@@ -45444,7 +46991,7 @@ const CAPABILITY_DATA = {
45444
46991
  "drops": []
45445
46992
  },
45446
46993
  "examples": [
45447
- "await client.companyLocations.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
46994
+ "await client.companyNoteAttachments.count({ filter: [{ field: 'companyNoteID', op: 'eq', value: 1 }] })"
45448
46995
  ],
45449
46996
  "permissions": "unknown",
45450
46997
  "pagination": {
@@ -45458,28 +47005,27 @@ const CAPABILITY_DATA = {
45458
47005
  "set": 0
45459
47006
  },
45460
47007
  "metadata": {
45461
- "purpose": "Count company location records matching a JSON filter.",
45462
- "usage": "Unwraps queryCount; returns a plain number.",
47008
+ "purpose": "Count attachment records matching a JSON filter. (under a company note)",
47009
+ "usage": "Unwraps queryCount; returns a plain number. Filter by companyNoteID for the note parent; companyID is a separate company reference. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility.",
45463
47010
  "preferredWhen": null,
45464
47011
  "related": [
45465
- "company_locations.query"
47012
+ "company_note_attachments.query"
45466
47013
  ],
45467
47014
  "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
45468
47015
  "untrustedFields": [
45469
- "description",
45470
- "name"
47016
+ "title"
45471
47017
  ]
45472
47018
  },
45473
47019
  "compact": null,
45474
47020
  "status": "tested"
45475
47021
  },
45476
47022
  {
45477
- "id": "company_locations.create",
45478
- "resource": "company_locations",
47023
+ "id": "company_note_attachments.create",
47024
+ "resource": "company_note_attachments",
45479
47025
  "udfCapable": false,
45480
47026
  "operation": "create",
45481
47027
  "kind": "primitive",
45482
- "endpoint": "POST /V1.0/Companies/{parentId}/Locations",
47028
+ "endpoint": "POST /V1.0/CompanyNotes/{parentId}/Attachments",
45483
47029
  "effect": "write",
45484
47030
  "flags": [],
45485
47031
  "dryRun": true,
@@ -45502,7 +47048,7 @@ const CAPABILITY_DATA = {
45502
47048
  "drops": []
45503
47049
  },
45504
47050
  "examples": [
45505
- "await client.companyLocations.create('example-value', { name: 'example' }, { dryRun: true })"
47051
+ "await client.companyNoteAttachments.create(1, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: 1, data: 'bm90ZQ==' }, { dryRun: true })"
45506
47052
  ],
45507
47053
  "permissions": "unknown",
45508
47054
  "pagination": {
@@ -45516,34 +47062,46 @@ const CAPABILITY_DATA = {
45516
47062
  "set": 1
45517
47063
  },
45518
47064
  "metadata": {
45519
- "purpose": "Create a company location.",
45520
- "usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
45521
- "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
47065
+ "purpose": "Create an attachment. (under a company note)",
47066
+ "usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. FILE_ATTACHMENT requires base64 data; use current attachmentType/publish metadata and vendor file limits. ParentId addresses the CompanyNotes record. Permission and impersonation restrictions apply.",
47067
+ "preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
45522
47068
  "related": [
45523
- "company_locations.update"
47069
+ "company_note_attachments.get"
45524
47070
  ],
45525
47071
  "untrustedFields": [
45526
- "description",
45527
- "name"
45528
- ]
47072
+ "title"
47073
+ ],
47074
+ "createRequirements": {
47075
+ "requiresByValue": [
47076
+ {
47077
+ "field": "attachmentType",
47078
+ "value": "FILE_ATTACHMENT",
47079
+ "requires": {
47080
+ "allOf": [
47081
+ "data"
47082
+ ]
47083
+ }
47084
+ }
47085
+ ]
47086
+ }
45529
47087
  },
45530
47088
  "compact": null,
45531
47089
  "status": "tested"
45532
47090
  },
45533
47091
  {
45534
- "id": "company_locations.delete",
45535
- "resource": "company_locations",
47092
+ "id": "company_note_attachments.delete",
47093
+ "resource": "company_note_attachments",
45536
47094
  "udfCapable": false,
45537
47095
  "operation": "delete",
45538
47096
  "kind": "primitive",
45539
- "endpoint": "DELETE /V1.0/Companies/{parentId}/Locations/{id}",
47097
+ "endpoint": "DELETE /V1.0/CompanyNotes/{parentId}/Attachments/{id}",
45540
47098
  "effect": "destructive",
45541
47099
  "flags": [
45542
47100
  "idempotent",
45543
47101
  "requiresApproval"
45544
47102
  ],
45545
47103
  "dryRun": true,
45546
- "envelope": "OperationResultModel",
47104
+ "envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
45547
47105
  "inputSchema": {
45548
47106
  "parentId": {
45549
47107
  "type": "string | number",
@@ -45558,11 +47116,11 @@ const CAPABILITY_DATA = {
45558
47116
  },
45559
47117
  "inputSchemaStrict": true,
45560
47118
  "outputSchema": {
45561
- "type": "OperationResultModel",
47119
+ "type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
45562
47120
  "drops": []
45563
47121
  },
45564
47122
  "examples": [
45565
- "await invoke(client, 'company_locations.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_locations.delete' })"
47123
+ "await invoke(client, 'company_note_attachments.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'company_note_attachments.delete' })"
45566
47124
  ],
45567
47125
  "permissions": "unknown",
45568
47126
  "pagination": {
@@ -45576,31 +47134,30 @@ const CAPABILITY_DATA = {
45576
47134
  "set": 2
45577
47135
  },
45578
47136
  "metadata": {
45579
- "purpose": "Delete a company location.",
47137
+ "purpose": "Delete an attachment. (under a company note)",
45580
47138
  "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
45581
47139
  "preferredWhen": null,
45582
47140
  "related": [
45583
- "company_locations.get"
47141
+ "company_note_attachments.get"
45584
47142
  ],
45585
47143
  "untrustedFields": [
45586
- "description",
45587
- "name"
47144
+ "title"
45588
47145
  ]
45589
47146
  },
45590
47147
  "compact": null,
45591
47148
  "status": "tested"
45592
47149
  },
45593
47150
  {
45594
- "id": "company_locations.get",
45595
- "resource": "company_locations",
47151
+ "id": "company_note_attachments.get",
47152
+ "resource": "company_note_attachments",
45596
47153
  "udfCapable": false,
45597
47154
  "operation": "get",
45598
47155
  "kind": "primitive",
45599
- "endpoint": "GET /V1.0/Companies/{parentId}/Locations/{id}",
47156
+ "endpoint": "GET /V1.0/CompanyNotes/{parentId}/Attachments/{id}",
45600
47157
  "effect": "read",
45601
47158
  "flags": [],
45602
47159
  "dryRun": false,
45603
- "envelope": "ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]",
47160
+ "envelope": "CompanyNoteAttachmentModel",
45604
47161
  "inputSchema": {
45605
47162
  "parentId": {
45606
47163
  "type": "string | number",
@@ -45627,11 +47184,11 @@ const CAPABILITY_DATA = {
45627
47184
  },
45628
47185
  "inputSchemaStrict": true,
45629
47186
  "outputSchema": {
45630
- "type": "ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]",
47187
+ "type": "CompanyNoteAttachmentModel",
45631
47188
  "drops": []
45632
47189
  },
45633
47190
  "examples": [
45634
- "await client.companyLocations.get('example-value', 'example-value')"
47191
+ "await client.companyNoteAttachments.get('example-value', 'example-value')"
45635
47192
  ],
45636
47193
  "permissions": "unknown",
45637
47194
  "pagination": {
@@ -45645,28 +47202,27 @@ const CAPABILITY_DATA = {
45645
47202
  "set": 3
45646
47203
  },
45647
47204
  "metadata": {
45648
- "purpose": "Get one CompanyLocation by id.",
45649
- "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
45650
- "preferredWhen": "Preferred when the numeric id is already known; company_locations.resolve is for a field value.",
47205
+ "purpose": "Get one CompanyNoteAttachment by id.",
47206
+ "usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the company note id, followed by the attachment id.",
47207
+ "preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
45651
47208
  "related": [
45652
- "company_locations.resolve"
47209
+ "company_note_attachments.query"
45653
47210
  ],
45654
- "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use company_locations.search (compact summary) or a company_locations.query with includeFields.",
47211
+ "args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a company_note_attachments.query with includeFields.",
45655
47212
  "untrustedFields": [
45656
- "description",
45657
- "name"
47213
+ "title"
45658
47214
  ]
45659
47215
  },
45660
47216
  "compact": null,
45661
47217
  "status": "tested"
45662
47218
  },
45663
47219
  {
45664
- "id": "company_locations.getEntityInfo",
45665
- "resource": "company_locations",
47220
+ "id": "company_note_attachments.getEntityInfo",
47221
+ "resource": "company_note_attachments",
45666
47222
  "udfCapable": false,
45667
47223
  "operation": "getEntityInfo",
45668
47224
  "kind": "primitive",
45669
- "endpoint": "GET /V1.0/CompanyLocations/entityInformation",
47225
+ "endpoint": "GET /V1.0/CompanyNoteAttachments/entityInformation",
45670
47226
  "effect": "read",
45671
47227
  "flags": [],
45672
47228
  "dryRun": false,
@@ -45678,7 +47234,7 @@ const CAPABILITY_DATA = {
45678
47234
  "drops": []
45679
47235
  },
45680
47236
  "examples": [
45681
- "await client.companyLocations.getEntityInfo()"
47237
+ "await client.companyNoteAttachments.getEntityInfo()"
45682
47238
  ],
45683
47239
  "permissions": "unknown",
45684
47240
  "pagination": {
@@ -45692,27 +47248,26 @@ const CAPABILITY_DATA = {
45692
47248
  "set": 0
45693
47249
  },
45694
47250
  "metadata": {
45695
- "purpose": "Get the CompanyLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
47251
+ "purpose": "Get the CompanyNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
45696
47252
  "usage": "Unwraps info{}; drives client-side capability checks.",
45697
47253
  "preferredWhen": null,
45698
47254
  "related": [
45699
- "company_locations.getFieldInfo"
47255
+ "company_note_attachments.getFieldInfo"
45700
47256
  ],
45701
47257
  "untrustedFields": [
45702
- "description",
45703
- "name"
47258
+ "title"
45704
47259
  ]
45705
47260
  },
45706
47261
  "compact": null,
45707
47262
  "status": "tested"
45708
47263
  },
45709
47264
  {
45710
- "id": "company_locations.getFieldInfo",
45711
- "resource": "company_locations",
47265
+ "id": "company_note_attachments.getFieldInfo",
47266
+ "resource": "company_note_attachments",
45712
47267
  "udfCapable": false,
45713
47268
  "operation": "getFieldInfo",
45714
47269
  "kind": "primitive",
45715
- "endpoint": "GET /V1.0/CompanyLocations/entityInformation/fields",
47270
+ "endpoint": "GET /V1.0/CompanyNoteAttachments/entityInformation/fields",
45716
47271
  "effect": "read",
45717
47272
  "flags": [],
45718
47273
  "dryRun": false,
@@ -45724,7 +47279,7 @@ const CAPABILITY_DATA = {
45724
47279
  "drops": []
45725
47280
  },
45726
47281
  "examples": [
45727
- "await client.companyLocations.getFieldInfo()"
47282
+ "await client.companyNoteAttachments.getFieldInfo()"
45728
47283
  ],
45729
47284
  "permissions": "unknown",
45730
47285
  "pagination": {
@@ -45738,74 +47293,26 @@ const CAPABILITY_DATA = {
45738
47293
  "set": 0
45739
47294
  },
45740
47295
  "metadata": {
45741
- "purpose": "Get the CompanyLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
47296
+ "purpose": "Get the CompanyNoteAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
45742
47297
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
45743
47298
  "preferredWhen": null,
45744
47299
  "related": [
45745
- "company_locations.getEntityInfo",
45746
- "company_locations.getUdfInfo"
47300
+ "company_note_attachments.getEntityInfo"
45747
47301
  ],
45748
47302
  "untrustedFields": [
45749
- "description",
45750
- "name"
45751
- ]
45752
- },
45753
- "compact": null,
45754
- "status": "tested"
45755
- },
45756
- {
45757
- "id": "company_locations.getUdfInfo",
45758
- "resource": "company_locations",
45759
- "udfCapable": false,
45760
- "operation": "getUdfInfo",
45761
- "kind": "primitive",
45762
- "endpoint": "GET /V1.0/CompanyLocations/entityInformation/userDefinedFields",
45763
- "effect": "read",
45764
- "flags": [],
45765
- "dryRun": false,
45766
- "envelope": "UserDefinedFieldInformationResultModel",
45767
- "inputSchema": {},
45768
- "inputSchemaStrict": true,
45769
- "outputSchema": {
45770
- "type": "UserDefinedFieldInformationResultModel",
45771
- "drops": []
45772
- },
45773
- "examples": [
45774
- "await client.companyLocations.getUdfInfo()"
45775
- ],
45776
- "permissions": "unknown",
45777
- "pagination": {
45778
- "mode": "none"
45779
- },
45780
- "resolution": null,
45781
- "retry": {
45782
- "preset": "retry-ffb3a9cb"
45783
- },
45784
- "errors": {
45785
- "set": 0
45786
- },
45787
- "metadata": {
45788
- "purpose": "Get the CompanyLocation user-defined-field catalog.",
45789
- "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
45790
- "preferredWhen": null,
45791
- "related": [
45792
- "company_locations.getFieldInfo"
45793
- ],
45794
- "untrustedFields": [
45795
- "description",
45796
- "name"
47303
+ "title"
45797
47304
  ]
45798
47305
  },
45799
47306
  "compact": null,
45800
47307
  "status": "tested"
45801
47308
  },
45802
47309
  {
45803
- "id": "company_locations.query",
45804
- "resource": "company_locations",
47310
+ "id": "company_note_attachments.query",
47311
+ "resource": "company_note_attachments",
45805
47312
  "udfCapable": false,
45806
47313
  "operation": "query",
45807
47314
  "kind": "primitive",
45808
- "endpoint": "GET|POST /V1.0/CompanyLocations/query",
47315
+ "endpoint": "GET|POST /V1.0/CompanyNoteAttachments/query",
45809
47316
  "effect": "read",
45810
47317
  "flags": [],
45811
47318
  "dryRun": false,
@@ -45877,7 +47384,7 @@ const CAPABILITY_DATA = {
45877
47384
  "drops": []
45878
47385
  },
45879
47386
  "examples": [
45880
- "await client.companyLocations.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
47387
+ "await client.companyNoteAttachments.query({ filter: [{ field: 'companyNoteID', op: 'eq', value: 1 }], limit: 25 })"
45881
47388
  ],
45882
47389
  "permissions": "unknown",
45883
47390
  "pagination": {
@@ -45898,217 +47405,15 @@ const CAPABILITY_DATA = {
45898
47405
  "set": 4
45899
47406
  },
45900
47407
  "metadata": {
45901
- "purpose": "Query CompanyLocation records with a JSON filter.",
45902
- "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with companyID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
47408
+ "purpose": "Query CompanyNoteAttachment records with a JSON filter.",
47409
+ "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with companyNoteID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Filter by companyNoteID for the note parent; companyID is a separate company reference. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
45903
47410
  "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
45904
47411
  "related": [
45905
- "company_locations.resolve"
45906
- ],
45907
- "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer company_locations.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
45908
- "untrustedFields": [
45909
- "description",
45910
- "name"
45911
- ]
45912
- },
45913
- "compact": null,
45914
- "status": "tested"
45915
- },
45916
- {
45917
- "id": "company_locations.resolve",
45918
- "resource": "company_locations",
45919
- "udfCapable": false,
45920
- "operation": "resolve",
45921
- "kind": "helper",
45922
- "endpoint": null,
45923
- "effect": "read",
45924
- "flags": [],
45925
- "dryRun": false,
45926
- "envelope": null,
45927
- "inputSchema": {
45928
- "identifier": {
45929
- "type": "string | number",
45930
- "required": true,
45931
- "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
45932
- },
45933
- "opts": {
45934
- "type": "object",
45935
- "required": false,
45936
- "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
45937
- "properties": [
45938
- {
45939
- "name": "expand",
45940
- "type": "boolean",
45941
- "optional": true
45942
- }
45943
- ]
45944
- }
45945
- },
45946
- "inputSchemaStrict": true,
45947
- "outputSchema": {
45948
- "type": "CompanyLocationSummary",
45949
- "drops": []
45950
- },
45951
- "examples": [
45952
- "await client.companyLocations.resolve('example-value')"
45953
- ],
45954
- "permissions": "unknown",
45955
- "pagination": {
45956
- "mode": "none"
45957
- },
45958
- "resolution": {
45959
- "basis": "server-filter",
45960
- "maxScanRecords": 500,
45961
- "maxScanPages": 4
45962
- },
45963
- "retry": {
45964
- "preset": "retry-ffb3a9cb"
45965
- },
45966
- "errors": {
45967
- "set": 5
45968
- },
45969
- "metadata": {
45970
- "purpose": "Resolve a company location from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Company location record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
45971
- "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
45972
- "preferredWhen": null,
45973
- "related": [
45974
- "company_locations.get"
45975
- ],
45976
- "untrustedFields": [
45977
- "description",
45978
- "name"
45979
- ]
45980
- },
45981
- "compact": "CompanyLocationSummary",
45982
- "status": "tested"
45983
- },
45984
- {
45985
- "id": "company_locations.search",
45986
- "resource": "company_locations",
45987
- "udfCapable": false,
45988
- "operation": "search",
45989
- "kind": "helper",
45990
- "endpoint": null,
45991
- "effect": "read",
45992
- "flags": [],
45993
- "dryRun": false,
45994
- "envelope": null,
45995
- "inputSchema": {
45996
- "query": {
45997
- "type": "string",
45998
- "required": true,
45999
- "description": "The free text to match (contains) on the resource searchable fields."
46000
- },
46001
- "opts": {
46002
- "type": "object",
46003
- "required": false,
46004
- "description": "SearchOpts — { limit?: number } (1-500, default 25).",
46005
- "properties": [
46006
- {
46007
- "name": "limit",
46008
- "type": "number",
46009
- "optional": true
46010
- }
46011
- ]
46012
- }
46013
- },
46014
- "inputSchemaStrict": true,
46015
- "outputSchema": {
46016
- "type": "CompanyLocationSummary",
46017
- "drops": []
46018
- },
46019
- "examples": [
46020
- "await client.companyLocations.search('example')"
46021
- ],
46022
- "permissions": "unknown",
46023
- "pagination": {
46024
- "mode": "none"
46025
- },
46026
- "resolution": {
46027
- "basis": "server-filter",
46028
- "maxScanRecords": 500,
46029
- "maxScanPages": 4
46030
- },
46031
- "retry": {
46032
- "preset": "retry-ffb3a9cb"
46033
- },
46034
- "errors": {
46035
- "set": 5
46036
- },
46037
- "metadata": {
46038
- "purpose": "Search company location records by text (contains on the searchable fields).",
46039
- "usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
46040
- "preferredWhen": null,
46041
- "related": [
46042
- "company_locations.resolve",
46043
- "company_locations.query"
46044
- ],
46045
- "untrustedFields": [
46046
- "description",
46047
- "name"
46048
- ]
46049
- },
46050
- "compact": "CompanyLocationSummary",
46051
- "status": "tested"
46052
- },
46053
- {
46054
- "id": "company_locations.update",
46055
- "resource": "company_locations",
46056
- "udfCapable": false,
46057
- "operation": "update",
46058
- "kind": "primitive",
46059
- "endpoint": "PUT|PATCH /V1.0/Companies/{parentId}/Locations",
46060
- "effect": "write",
46061
- "flags": [
46062
- "idempotent"
46063
- ],
46064
- "dryRun": true,
46065
- "envelope": "OperationResultModel",
46066
- "inputSchema": {
46067
- "parentId": {
46068
- "type": "string | number",
46069
- "required": true,
46070
- "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
46071
- },
46072
- "id": {
46073
- "type": "string | number",
46074
- "required": true,
46075
- "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
46076
- },
46077
- "data": {
46078
- "type": "object",
46079
- "required": true,
46080
- "description": "The record payload (vendor model fields)."
46081
- }
46082
- },
46083
- "inputSchemaStrict": true,
46084
- "outputSchema": {
46085
- "type": "OperationResultModel",
46086
- "drops": []
46087
- },
46088
- "examples": [
46089
- "await client.companyLocations.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
46090
- ],
46091
- "permissions": "unknown",
46092
- "pagination": {
46093
- "mode": "none"
46094
- },
46095
- "resolution": null,
46096
- "retry": {
46097
- "preset": "retry-85897a3a"
46098
- },
46099
- "errors": {
46100
- "set": 1
46101
- },
46102
- "metadata": {
46103
- "purpose": "Update a company location.",
46104
- "usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id.",
46105
- "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
46106
- "related": [
46107
- "company_locations.get"
47412
+ "company_note_attachments.get"
46108
47413
  ],
47414
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
46109
47415
  "untrustedFields": [
46110
- "description",
46111
- "name"
47416
+ "title"
46112
47417
  ]
46113
47418
  },
46114
47419
  "compact": null,
@@ -49164,7 +50469,7 @@ const CAPABILITY_DATA = {
49164
50469
  },
49165
50470
  "metadata": {
49166
50471
  "purpose": "Query ConfigurationItemDnsRecord records with a JSON filter.",
49167
- "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with configurationItemID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
50472
+ "usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with installedProductID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
49168
50473
  "preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
49169
50474
  "related": [
49170
50475
  "configuration_item_dns_records.resolve"
@@ -82640,8 +83945,8 @@ const CAPABILITY_DATA = {
82640
83945
  ]
82641
83946
  },
82642
83947
  "operations": {
82643
- "planHash": "959981d335cfd184d8b4e58074d1ab6997b2db87a62683ed13e99c149f8cd4fa",
82644
- "builtAt": "2026-11-17T15:37:22.566Z",
83948
+ "planHash": "275fdf2fd6712f9384c1a65f98c5faf1fda9695475ffbdf35c08e574c18b4157",
83949
+ "builtAt": "2026-11-18T09:40:46.384Z",
82645
83950
  "records": [
82646
83951
  {
82647
83952
  "id": "operations.aggregate",