node-autotask 0.87.0 → 0.88.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 (45) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/MCP_TOOL_CATALOG.json +152 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +546 -26
  5. package/dist/capabilities-data.js +545 -25
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-RU4ECNQN.cjs → chunk-AB326MJO.cjs} +200 -200
  9. package/dist/{chunk-BD4AUGCJ.cjs → chunk-CM5O672I.cjs} +5 -4
  10. package/dist/{chunk-HUA4WB4N.cjs → chunk-ESKQAINP.cjs} +31 -30
  11. package/dist/{chunk-CUZJJCI5.cjs → chunk-GEFUSYH5.cjs} +325 -165
  12. package/dist/{chunk-GAFG7RHG.js → chunk-K72PPAAD.js} +312 -152
  13. package/dist/{chunk-NXSQXXNK.js → chunk-LGOJ2HBH.js} +3 -2
  14. package/dist/{chunk-G57Q7OAC.js → chunk-QKRHKLVY.js} +2 -2
  15. package/dist/{chunk-YVNGUGG6.cjs → chunk-SHJ7EOBW.cjs} +3 -3
  16. package/dist/{chunk-7NKB4UXV.js → chunk-X6VWD6WW.js} +5 -4
  17. package/dist/{chunk-EXNDYJPG.js → chunk-ZADTVF6M.js} +3 -3
  18. package/dist/{index-CsL5gGJo.d.ts → index-BFgZJsqx.d.ts} +13 -7
  19. package/dist/{index-Cxfr_DOD.d.cts → index-D0KHVqoO.d.cts} +29 -1
  20. package/dist/{index-Cxfr_DOD.d.ts → index-D0KHVqoO.d.ts} +29 -1
  21. package/dist/{index-DGiua9uK.d.cts → index-DsA1-2GA.d.cts} +13 -7
  22. package/dist/index.cjs +90 -87
  23. package/dist/index.d.cts +4 -3
  24. package/dist/index.d.ts +4 -3
  25. package/dist/index.js +9 -6
  26. package/dist/operations/index.cjs +53 -53
  27. package/dist/operations/index.d.cts +4 -4
  28. package/dist/operations/index.d.ts +4 -4
  29. package/dist/operations/index.js +3 -3
  30. package/dist/pool.cjs +13 -13
  31. package/dist/pool.d.cts +1 -1
  32. package/dist/pool.d.ts +1 -1
  33. package/dist/pool.js +5 -5
  34. package/dist/resources/index.cjs +28 -28
  35. package/dist/resources/index.d.cts +2 -2
  36. package/dist/resources/index.d.ts +2 -2
  37. package/dist/resources/index.js +4 -4
  38. package/dist/types/index.d.cts +1 -1
  39. package/dist/types/index.d.ts +1 -1
  40. package/dist/untrusted.cjs +11 -11
  41. package/dist/untrusted.d.cts +1 -1
  42. package/dist/untrusted.d.ts +1 -1
  43. package/dist/untrusted.js +1 -1
  44. package/docs/API.md +6 -2
  45. package/package.json +1 -1
package/capabilities.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "generatedAt": "2026-11-20T11:02:13.927Z",
2
+ "generatedAt": "2026-11-20T22:03:19.300Z",
3
3
  "groups": {
4
4
  "B": {
5
- "planHash": "c97deac4ac7c3ca9ce4cea10ac6a50bb19b6517993d9657c52397964e1fcf715",
6
- "builtAt": "2026-11-20T11:02:13.903Z",
5
+ "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
6
+ "builtAt": "2026-11-20T22:03:19.289Z",
7
7
  "records": [
8
8
  {
9
9
  "id": "appointments.count",
@@ -46603,8 +46603,8 @@
46603
46603
  ]
46604
46604
  },
46605
46605
  "A": {
46606
- "planHash": "c97deac4ac7c3ca9ce4cea10ac6a50bb19b6517993d9657c52397964e1fcf715",
46607
- "builtAt": "2026-11-20T11:02:13.904Z",
46606
+ "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
46607
+ "builtAt": "2026-11-20T22:03:19.289Z",
46608
46608
  "records": [
46609
46609
  {
46610
46610
  "id": "attachment_info.count",
@@ -71919,6 +71919,507 @@
71919
71919
  "compact": null,
71920
71920
  "status": "tested"
71921
71921
  },
71922
+ {
71923
+ "id": "inventory_locations.count",
71924
+ "resource": "inventory_locations",
71925
+ "udfCapable": false,
71926
+ "operation": "count",
71927
+ "kind": "primitive",
71928
+ "endpoint": "POST /V1.0/InventoryLocations/query/count",
71929
+ "effect": "read",
71930
+ "flags": [],
71931
+ "dryRun": false,
71932
+ "envelope": "QueryCountResultModel",
71933
+ "inputSchema": {
71934
+ "params": {
71935
+ "type": "object",
71936
+ "required": false,
71937
+ "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.",
71938
+ "properties": [
71939
+ {
71940
+ "name": "filter",
71941
+ "type": "FilterCondition[]",
71942
+ "optional": true
71943
+ },
71944
+ {
71945
+ "name": "fieldCheck",
71946
+ "type": "boolean",
71947
+ "optional": true
71948
+ }
71949
+ ]
71950
+ }
71951
+ },
71952
+ "inputSchemaStrict": true,
71953
+ "outputSchema": {
71954
+ "type": "QueryCountResultModel",
71955
+ "drops": []
71956
+ },
71957
+ "examples": [
71958
+ "await invoke(client, 'inventory_locations.count', [{ filter: [{ field: 'isActive', op: 'eq', value: true }] }])"
71959
+ ],
71960
+ "permissions": "unknown",
71961
+ "pagination": {
71962
+ "mode": "none"
71963
+ },
71964
+ "resolution": null,
71965
+ "retry": {
71966
+ "preset": "retry-ffb3a9cb"
71967
+ },
71968
+ "errors": {
71969
+ "set": 6
71970
+ },
71971
+ "metadata": {
71972
+ "purpose": "Count inventory location records matching a JSON filter.",
71973
+ "usage": "Unwraps queryCount; returns a plain number. Inventory Manage Locations permission and Inventory module/security access are required. Reads require View; create/update require View and Create. Empty reads are conditional on user permissions and visibility, not proof of tenant-wide absence. ",
71974
+ "preferredWhen": null,
71975
+ "related": [
71976
+ "inventory_locations.query"
71977
+ ],
71978
+ "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.",
71979
+ "untrustedFields": [
71980
+ "locationName"
71981
+ ]
71982
+ },
71983
+ "compact": null,
71984
+ "status": "tested"
71985
+ },
71986
+ {
71987
+ "id": "inventory_locations.create",
71988
+ "resource": "inventory_locations",
71989
+ "udfCapable": false,
71990
+ "operation": "create",
71991
+ "kind": "primitive",
71992
+ "endpoint": "POST /V1.0/InventoryLocations",
71993
+ "effect": "write",
71994
+ "flags": [],
71995
+ "dryRun": true,
71996
+ "envelope": "OperationResultModel",
71997
+ "inputSchema": {
71998
+ "data": {
71999
+ "type": "object",
72000
+ "required": true,
72001
+ "description": "The record payload (vendor model fields)."
72002
+ }
72003
+ },
72004
+ "inputSchemaStrict": true,
72005
+ "outputSchema": {
72006
+ "type": "OperationResultModel",
72007
+ "drops": []
72008
+ },
72009
+ "examples": [
72010
+ "await client.inventoryLocations.create({ locationName: 'Warehouse', isActive: true }, { dryRun: true })"
72011
+ ],
72012
+ "permissions": "unknown",
72013
+ "pagination": {
72014
+ "mode": "none"
72015
+ },
72016
+ "resolution": null,
72017
+ "retry": {
72018
+ "preset": "retry-c5657094"
72019
+ },
72020
+ "errors": {
72021
+ "set": 15
72022
+ },
72023
+ "metadata": {
72024
+ "purpose": "Create an inventory location.",
72025
+ "usage": "Inventory Manage Locations permission and Inventory module/security access are required. Reads require View; create/update require View and Create. Empty reads are conditional on user permissions and visibility, not proof of tenant-wide absence. Required locationName (nonblank, at most 50 characters) and boolean isActive. locationName must be unique; the vendor enforces uniqueness. isDefault, resourceID and impersonatorCreatorResourceID are read-only; the SDK does not assign a default or a resource association. There is no public DELETE for InventoryLocations; creation cannot be undone through this API. Preview first.",
72026
+ "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
72027
+ "related": [
72028
+ "inventory_locations.update"
72029
+ ],
72030
+ "deleteBoundary": {
72031
+ "resource": "inventory_locations",
72032
+ "note": "The vendor defines no DELETE for inventory_locations (spec-derived); a created inventory location cannot be removed through the public API.",
72033
+ "proof": "spec-derived"
72034
+ },
72035
+ "untrustedFields": [
72036
+ "locationName"
72037
+ ],
72038
+ "accountWide": true,
72039
+ "createRequirements": {
72040
+ "requires": {
72041
+ "allOf": [
72042
+ "locationName",
72043
+ "isActive"
72044
+ ]
72045
+ }
72046
+ }
72047
+ },
72048
+ "compact": null,
72049
+ "status": "tested"
72050
+ },
72051
+ {
72052
+ "id": "inventory_locations.get",
72053
+ "resource": "inventory_locations",
72054
+ "udfCapable": false,
72055
+ "operation": "get",
72056
+ "kind": "primitive",
72057
+ "endpoint": "GET /V1.0/InventoryLocations/{id}",
72058
+ "effect": "read",
72059
+ "flags": [],
72060
+ "dryRun": false,
72061
+ "envelope": "ItemQueryResultModel[InventoryLocationModel,InventoryLocation]",
72062
+ "inputSchema": {
72063
+ "id": {
72064
+ "type": "string | number",
72065
+ "required": true,
72066
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
72067
+ },
72068
+ "opts": {
72069
+ "type": "object",
72070
+ "required": false,
72071
+ "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.",
72072
+ "properties": [
72073
+ {
72074
+ "name": "fresh",
72075
+ "type": "boolean",
72076
+ "optional": true
72077
+ }
72078
+ ]
72079
+ }
72080
+ },
72081
+ "inputSchemaStrict": true,
72082
+ "outputSchema": {
72083
+ "type": "ItemQueryResultModel[InventoryLocationModel,InventoryLocation]",
72084
+ "drops": []
72085
+ },
72086
+ "examples": [
72087
+ "await client.inventoryLocations.get(7)"
72088
+ ],
72089
+ "permissions": "unknown",
72090
+ "pagination": {
72091
+ "mode": "none"
72092
+ },
72093
+ "resolution": null,
72094
+ "retry": {
72095
+ "preset": "retry-ffb3a9cb"
72096
+ },
72097
+ "errors": {
72098
+ "set": 3
72099
+ },
72100
+ "metadata": {
72101
+ "purpose": "Get one InventoryLocation by id.",
72102
+ "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Inventory Manage Locations permission and Inventory module/security access are required. Reads require View; create/update require View and Create. Empty reads are conditional on user permissions and visibility, not proof of tenant-wide absence. ",
72103
+ "preferredWhen": "Preferred when the numeric id is already known.",
72104
+ "related": [
72105
+ "inventory_locations.query"
72106
+ ],
72107
+ "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 inventory_locations.query with includeFields.",
72108
+ "untrustedFields": [
72109
+ "locationName"
72110
+ ]
72111
+ },
72112
+ "compact": null,
72113
+ "status": "tested"
72114
+ },
72115
+ {
72116
+ "id": "inventory_locations.getEntityInfo",
72117
+ "resource": "inventory_locations",
72118
+ "udfCapable": false,
72119
+ "operation": "getEntityInfo",
72120
+ "kind": "primitive",
72121
+ "endpoint": "GET /V1.0/InventoryLocations/entityInformation",
72122
+ "effect": "read",
72123
+ "flags": [],
72124
+ "dryRun": false,
72125
+ "envelope": "EntityInformationResultModel",
72126
+ "inputSchema": {},
72127
+ "inputSchemaStrict": true,
72128
+ "outputSchema": {
72129
+ "type": "EntityInformationResultModel",
72130
+ "drops": []
72131
+ },
72132
+ "examples": [
72133
+ "await client.inventoryLocations.getEntityInfo()"
72134
+ ],
72135
+ "permissions": "unknown",
72136
+ "pagination": {
72137
+ "mode": "none"
72138
+ },
72139
+ "resolution": null,
72140
+ "retry": {
72141
+ "preset": "retry-ffb3a9cb"
72142
+ },
72143
+ "errors": {
72144
+ "set": 6
72145
+ },
72146
+ "metadata": {
72147
+ "purpose": "Get the InventoryLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
72148
+ "usage": "Unwraps info{}; drives client-side capability checks.",
72149
+ "preferredWhen": null,
72150
+ "related": [
72151
+ "inventory_locations.getFieldInfo"
72152
+ ],
72153
+ "untrustedFields": [
72154
+ "locationName"
72155
+ ]
72156
+ },
72157
+ "compact": null,
72158
+ "status": "tested"
72159
+ },
72160
+ {
72161
+ "id": "inventory_locations.getFieldInfo",
72162
+ "resource": "inventory_locations",
72163
+ "udfCapable": false,
72164
+ "operation": "getFieldInfo",
72165
+ "kind": "primitive",
72166
+ "endpoint": "GET /V1.0/InventoryLocations/entityInformation/fields",
72167
+ "effect": "read",
72168
+ "flags": [],
72169
+ "dryRun": false,
72170
+ "envelope": "FieldInformationResultModel",
72171
+ "inputSchema": {},
72172
+ "inputSchemaStrict": true,
72173
+ "outputSchema": {
72174
+ "type": "FieldInformationResultModel",
72175
+ "drops": []
72176
+ },
72177
+ "examples": [
72178
+ "await client.inventoryLocations.getFieldInfo()"
72179
+ ],
72180
+ "permissions": "unknown",
72181
+ "pagination": {
72182
+ "mode": "none"
72183
+ },
72184
+ "resolution": null,
72185
+ "retry": {
72186
+ "preset": "retry-ffb3a9cb"
72187
+ },
72188
+ "errors": {
72189
+ "set": 6
72190
+ },
72191
+ "metadata": {
72192
+ "purpose": "Get the InventoryLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
72193
+ "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.",
72194
+ "preferredWhen": null,
72195
+ "related": [
72196
+ "inventory_locations.getEntityInfo",
72197
+ "inventory_locations.getUdfInfo"
72198
+ ],
72199
+ "untrustedFields": [
72200
+ "locationName"
72201
+ ]
72202
+ },
72203
+ "compact": null,
72204
+ "status": "tested"
72205
+ },
72206
+ {
72207
+ "id": "inventory_locations.getUdfInfo",
72208
+ "resource": "inventory_locations",
72209
+ "udfCapable": false,
72210
+ "operation": "getUdfInfo",
72211
+ "kind": "primitive",
72212
+ "endpoint": "GET /V1.0/InventoryLocations/entityInformation/userDefinedFields",
72213
+ "effect": "read",
72214
+ "flags": [],
72215
+ "dryRun": false,
72216
+ "envelope": "UserDefinedFieldInformationResultModel",
72217
+ "inputSchema": {},
72218
+ "inputSchemaStrict": true,
72219
+ "outputSchema": {
72220
+ "type": "UserDefinedFieldInformationResultModel",
72221
+ "drops": []
72222
+ },
72223
+ "examples": [
72224
+ "await client.inventoryLocations.getUdfInfo()"
72225
+ ],
72226
+ "permissions": "unknown",
72227
+ "pagination": {
72228
+ "mode": "none"
72229
+ },
72230
+ "resolution": null,
72231
+ "retry": {
72232
+ "preset": "retry-ffb3a9cb"
72233
+ },
72234
+ "errors": {
72235
+ "set": 6
72236
+ },
72237
+ "metadata": {
72238
+ "purpose": "Get the InventoryLocation user-defined-field catalog.",
72239
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
72240
+ "preferredWhen": null,
72241
+ "related": [
72242
+ "inventory_locations.getFieldInfo"
72243
+ ],
72244
+ "untrustedFields": [
72245
+ "locationName"
72246
+ ]
72247
+ },
72248
+ "compact": null,
72249
+ "status": "tested"
72250
+ },
72251
+ {
72252
+ "id": "inventory_locations.query",
72253
+ "resource": "inventory_locations",
72254
+ "udfCapable": false,
72255
+ "operation": "query",
72256
+ "kind": "primitive",
72257
+ "endpoint": "GET|POST /V1.0/InventoryLocations/query",
72258
+ "effect": "read",
72259
+ "flags": [],
72260
+ "dryRun": false,
72261
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
72262
+ "inputSchema": {
72263
+ "params": {
72264
+ "type": "object",
72265
+ "required": false,
72266
+ "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 + a capped number of cold name reads per call (several ids of one table share one batched read); 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/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) 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 uncached name-read cap, an id a batched name read did not return, 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.",
72267
+ "properties": [
72268
+ {
72269
+ "name": "filter",
72270
+ "type": "FilterCondition[]",
72271
+ "optional": true
72272
+ },
72273
+ {
72274
+ "name": "limit",
72275
+ "type": "number",
72276
+ "optional": true,
72277
+ "default": 500
72278
+ },
72279
+ {
72280
+ "name": "latest",
72281
+ "type": "number",
72282
+ "optional": true
72283
+ },
72284
+ {
72285
+ "name": "noteChars",
72286
+ "type": "number",
72287
+ "optional": true
72288
+ },
72289
+ {
72290
+ "name": "includeFields",
72291
+ "type": "string[]",
72292
+ "optional": true
72293
+ },
72294
+ {
72295
+ "name": "fieldCheck",
72296
+ "type": "boolean",
72297
+ "optional": true,
72298
+ "default": true
72299
+ },
72300
+ {
72301
+ "name": "names",
72302
+ "type": "boolean",
72303
+ "optional": true
72304
+ },
72305
+ {
72306
+ "name": "via",
72307
+ "type": "\"post\" | \"get\"",
72308
+ "optional": true
72309
+ },
72310
+ {
72311
+ "name": "acknowledgeUnscoped",
72312
+ "type": "boolean",
72313
+ "optional": true
72314
+ },
72315
+ {
72316
+ "name": "walk",
72317
+ "type": "object",
72318
+ "optional": true
72319
+ }
72320
+ ]
72321
+ }
72322
+ },
72323
+ "inputSchemaStrict": true,
72324
+ "outputSchema": {
72325
+ "type": "QueryActionResult[<Model>,<Entity>]",
72326
+ "drops": []
72327
+ },
72328
+ "examples": [
72329
+ "await invoke(client, 'inventory_locations.query', [{ filter: [{ field: 'isActive', op: 'eq', value: true }], limit: 25 }])"
72330
+ ],
72331
+ "permissions": "unknown",
72332
+ "pagination": {
72333
+ "mode": "cursor",
72334
+ "vendorDefault": 10,
72335
+ "vendorMax": 500,
72336
+ "pageGuard": 1000,
72337
+ "queryBounded": {
72338
+ "default": 500,
72339
+ "max": 2500
72340
+ }
72341
+ },
72342
+ "resolution": null,
72343
+ "retry": {
72344
+ "preset": "retry-ffb3a9cb"
72345
+ },
72346
+ "errors": {
72347
+ "set": 16
72348
+ },
72349
+ "metadata": {
72350
+ "purpose": "Query InventoryLocation records with a JSON filter.",
72351
+ "usage": "Server-side pagination: one call walks the vendor cursor until the limit, end, or 1000-page guard. POST is the default and carries the same QueryModel on continuation. GET mode carries the original search JSON on each GET continuation. 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. Inventory Manage Locations permission and Inventory module/security access are required. Reads require View; create/update require View and Create. Empty reads are conditional on user permissions and visibility, not proof of tenant-wide absence. ",
72352
+ "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).",
72353
+ "related": [
72354
+ "inventory_locations.get"
72355
+ ],
72356
+ "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.",
72357
+ "untrustedFields": [
72358
+ "locationName"
72359
+ ]
72360
+ },
72361
+ "compact": null,
72362
+ "status": "tested"
72363
+ },
72364
+ {
72365
+ "id": "inventory_locations.update",
72366
+ "resource": "inventory_locations",
72367
+ "udfCapable": false,
72368
+ "operation": "update",
72369
+ "kind": "primitive",
72370
+ "endpoint": "PATCH /V1.0/InventoryLocations",
72371
+ "effect": "write",
72372
+ "flags": [
72373
+ "idempotent"
72374
+ ],
72375
+ "dryRun": true,
72376
+ "envelope": "OperationResultModel",
72377
+ "inputSchema": {
72378
+ "id": {
72379
+ "type": "string | number",
72380
+ "required": true,
72381
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
72382
+ },
72383
+ "data": {
72384
+ "type": "object",
72385
+ "required": true,
72386
+ "description": "The record payload (vendor model fields)."
72387
+ }
72388
+ },
72389
+ "inputSchemaStrict": true,
72390
+ "outputSchema": {
72391
+ "type": "OperationResultModel",
72392
+ "drops": []
72393
+ },
72394
+ "examples": [
72395
+ "await client.inventoryLocations.update(7, { locationName: 'Renamed warehouse' }, { dryRun: true })"
72396
+ ],
72397
+ "permissions": "unknown",
72398
+ "pagination": {
72399
+ "mode": "none"
72400
+ },
72401
+ "resolution": null,
72402
+ "retry": {
72403
+ "preset": "retry-c5657094"
72404
+ },
72405
+ "errors": {
72406
+ "set": 17
72407
+ },
72408
+ "metadata": {
72409
+ "purpose": "Update an inventory location.",
72410
+ "usage": "Inventory Manage Locations permission and Inventory module/security access are required. Reads require View; create/update require View and Create. Empty reads are conditional on user permissions and visibility, not proof of tenant-wide absence. PATCH the collection with the path-authoritative id in the body; only locationName and isActive are writable. Default locations cannot be inactivated. Inactivation requires a fresh current record with isDefault explicitly false; unknown/default facts fail closed. locationName is unique (vendor-enforced) and at most 50 characters. Read-only isDefault/resourceID/audit fields cannot be changed. No timestamp concurrency field exists in the documented model; fresh preflight is not an atomic lock. No replacing PUT fallback is issued. Explicit stale tokens are refused because no timestamp is documented. The replacing collection PUT variant remains excluded and tracked. A maintenance response from PATCH is surfaced without automatic replay. Verify whether the update took effect before deciding to retry. If an update is still needed, preview again to refresh the target facts. The checked PATCH is never replayed to a different zone.",
72411
+ "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
72412
+ "related": [
72413
+ "inventory_locations.get"
72414
+ ],
72415
+ "untrustedFields": [
72416
+ "locationName"
72417
+ ],
72418
+ "accountWide": true
72419
+ },
72420
+ "compact": null,
72421
+ "status": "tested"
72422
+ },
71922
72423
  {
71923
72424
  "id": "invoices.count",
71924
72425
  "resource": "invoices",
@@ -80795,7 +81296,7 @@
80795
81296
  "preset": "retry-1849870d"
80796
81297
  },
80797
81298
  "errors": {
80798
- "set": 16
81299
+ "set": 18
80799
81300
  },
80800
81301
  "metadata": {
80801
81302
  "purpose": "Delete an attachment under a task.",
@@ -81066,7 +81567,7 @@
81066
81567
  "preset": "retry-ffb3a9cb"
81067
81568
  },
81068
81569
  "errors": {
81069
- "set": 17
81570
+ "set": 16
81070
81571
  },
81071
81572
  "metadata": {
81072
81573
  "purpose": "Query TaskAttachment records with a JSON filter.",
@@ -89834,7 +90335,7 @@
89834
90335
  "preset": "retry-6980a375"
89835
90336
  },
89836
90337
  "errors": {
89837
- "set": 18
90338
+ "set": 19
89838
90339
  },
89839
90340
  "metadata": {
89840
90341
  "purpose": "Move a ticket to a target status in ONE op — the node validates targetStatus against the tenant's LIVE status picklist (entity metadata; vendor rejection is the fallback when the metadata is unavailable) + the live-discovered per-status required-field map and fills the proven-safe defaults itself (the vendor 500s when a target status has unsatisfied field requirements; the MCP LLM has no way to know the map).",
@@ -90239,7 +90740,7 @@
90239
90740
  "preset": "retry-ffb3a9cb"
90240
90741
  },
90241
90742
  "errors": {
90242
- "set": 19
90743
+ "set": 20
90243
90744
  },
90244
90745
  "metadata": {
90245
90746
  "purpose": "List the tickets a resource is assigned to — as primary owner, as a secondary resource, or both — de-duplicated, with the four reconciling counts and an optional open-only filter that uses the tenant's own closed-status set.",
@@ -91429,7 +91930,7 @@
91429
91930
  "preset": "retry-ffb3a9cb"
91430
91931
  },
91431
91932
  "errors": {
91432
- "set": 20
91933
+ "set": 21
91433
91934
  },
91434
91935
  "metadata": {
91435
91936
  "purpose": "Report the ticket status picklist and the ids this SDK treats as CLOSED for the caller's tenant, with the provenance of that set (read from the tenant's picklist, or the documented assumed fallback).",
@@ -91788,8 +92289,8 @@
91788
92289
  ]
91789
92290
  },
91790
92291
  "operations": {
91791
- "planHash": "c97deac4ac7c3ca9ce4cea10ac6a50bb19b6517993d9657c52397964e1fcf715",
91792
- "builtAt": "2026-11-20T11:02:13.904Z",
92292
+ "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
92293
+ "builtAt": "2026-11-20T22:03:19.289Z",
91793
92294
  "records": [
91794
92295
  {
91795
92296
  "id": "operations.aggregate",
@@ -91872,7 +92373,7 @@
91872
92373
  "preset": "retry-ffb3a9cb"
91873
92374
  },
91874
92375
  "errors": {
91875
- "set": 21
92376
+ "set": 22
91876
92377
  },
91877
92378
  "metadata": {
91878
92379
  "purpose": "Fold any query surface into groups/sums/totals in one bounded call — or count it with the vendor count endpoint when no folding is needed — with blind-surface and truncation honesty (caps documented: the walk scans at most 2500 rows and top keeps at most 100 groups — a truncated aggregate is a PARTIAL answer, never a tenant-wide total); date fields bucket via the closed groupBy suffix <field>@month | @week | @year (ISO labels, UTC-anchored). Use it for totals, sums, counts and hours per ticket, resource, company, contract or month (group by any field), e.g. time entries hours grouped by ticket and resource",
@@ -92080,7 +92581,7 @@
92080
92581
  "preset": "retry-ffb3a9cb"
92081
92582
  },
92082
92583
  "errors": {
92083
- "set": 22
92584
+ "set": 23
92084
92585
  },
92085
92586
  "metadata": {
92086
92587
  "purpose": "Accounts-receivable aging at a point in time, in one budgeted call: open invoices per company bucketed by days past due (current, 1-30, 31-60, 61-90, over 90, no due date), with totals per currency.",
@@ -92146,7 +92647,7 @@
92146
92647
  "preset": "retry-ffb3a9cb"
92147
92648
  },
92148
92649
  "errors": {
92149
- "set": 23
92650
+ "set": 24
92150
92651
  },
92151
92652
  "metadata": {
92152
92653
  "purpose": "Read static creation requirements, prior validation findings and unproven input guidance. This is not a live test of current-tenant capability, inventory or permissions.",
@@ -92469,7 +92970,7 @@
92469
92970
  "preset": "retry-ffb3a9cb"
92470
92971
  },
92471
92972
  "errors": {
92472
- "set": 24
92973
+ "set": 25
92473
92974
  },
92474
92975
  "metadata": {
92475
92976
  "purpose": "Fetch the LIVE vendor field catalog for the named resources in one bounded read call: which fields exist, which are required, types, maxLength, read-only, queryable, picklist-ness — the on-demand refresh for the point-in-time pins (operations.createGuidance, the zoneFacts) when the vendor has moved since they were verified. The wire cost (resources × include) is refused pre-request above the cap, never truncated; with the opt-in fieldCache configured, repeat reads inside the TTL cost no wire. It reports picklist-ness as a flag (isPickList) and picklist field NAMES (picklistFields); with the opt-in labels: true the projected picklist rows carry the vendor's exposed picklist VALUES (labels next to each value), and without it the op serves no VALUES. A picklist VALUE the vendor does not expose to this API user is not resolvable from this catalog.",
@@ -92566,7 +93067,7 @@
92566
93067
  "preset": "retry-ffb3a9cb"
92567
93068
  },
92568
93069
  "errors": {
92569
- "set": 22
93070
+ "set": 23
92570
93071
  },
92571
93072
  "metadata": {
92572
93073
  "purpose": "Non-chargeable work in one budgeted call: non-billable and contract-covered billing items (value, labour hours, lines) per company, contract or contract type, posted or invoiced or not.",
@@ -92683,7 +93184,7 @@
92683
93184
  "preset": "retry-ffb3a9cb"
92684
93185
  },
92685
93186
  "errors": {
92686
- "set": 25
93187
+ "set": 26
92687
93188
  },
92688
93189
  "metadata": {
92689
93190
  "purpose": "Contract profit and margin grouped by contract, company, contract type, vertical or month over a window, in one budgeted call: a contracts.profitability fan-out with totals and per-contract coverage gaps.",
@@ -92773,7 +93274,7 @@
92773
93274
  "preset": "retry-ffb3a9cb"
92774
93275
  },
92775
93276
  "errors": {
92776
- "set": 22
93277
+ "set": 23
92777
93278
  },
92778
93279
  "metadata": {
92779
93280
  "purpose": "Monthly recurring revenue at a point in time per company, in one budgeted call: contract services, subscriptions and the month's contract charges (usage billing, counted as recurring revenue) reported apart, plus the contracts ending soon.",
@@ -92828,7 +93329,7 @@
92828
93329
  "preset": "retry-ffb3a9cb"
92829
93330
  },
92830
93331
  "errors": {
92831
- "set": 23
93332
+ "set": 24
92832
93333
  },
92833
93334
  "metadata": {
92834
93335
  "purpose": "Describe a resource’s SDK-covered parent/child operations, lookup keys and static create guidance without a vendor call. Current-user visibility and tenant inventory require live reads.",
@@ -93245,7 +93746,7 @@
93245
93746
  "preset": "retry-ffb3a9cb"
93246
93747
  },
93247
93748
  "errors": {
93248
- "set": 22
93749
+ "set": 23
93249
93750
  },
93250
93751
  "metadata": {
93251
93752
  "purpose": "Total revenue grouped by account vertical, contract type, company, contract, month or line of business over an invoice-date window, in one budgeted call with totals, excluded buckets, a reconciliation and optional non-chargeable work.",
@@ -93305,7 +93806,7 @@
93305
93806
  "preset": "retry-ffb3a9cb"
93306
93807
  },
93307
93808
  "errors": {
93308
- "set": 26
93809
+ "set": 27
93309
93810
  },
93310
93811
  "metadata": {
93311
93812
  "purpose": "Fence the vendor free text of a raw SDK read result in the untrusted-content markers, using the operation's own registry record as the field authority.",
@@ -93578,7 +94079,7 @@
93578
94079
  "preset": "retry-ffb3a9cb"
93579
94080
  },
93580
94081
  "errors": {
93581
- "set": 26
94082
+ "set": 27
93582
94083
  },
93583
94084
  "metadata": {
93584
94085
  "purpose": "Build a clickable Autotask UI deep link for a record in one ZERO-wire call, e.g. for the time entry or ticket a response is about.",
@@ -93669,7 +94170,7 @@
93669
94170
  "preset": "retry-ffb3a9cb"
93670
94171
  },
93671
94172
  "errors": {
93672
- "set": 27
94173
+ "set": 28
93673
94174
  },
93674
94175
  "metadata": {
93675
94176
  "purpose": "Work in progress in one budgeted call: billable time entries no billing item references yet (unposted), in hours, per company, resource or contract type, split approved / unapproved where the tenant records approval.",
@@ -93964,6 +94465,21 @@
93964
94465
  "REDIRECT_BLOCKED",
93965
94466
  "FORBIDDEN"
93966
94467
  ],
94468
+ [
94469
+ "BAD_REQUEST",
94470
+ "CONFIG_ERROR",
94471
+ "NETWORK_ERROR",
94472
+ "UNAUTHORIZED",
94473
+ "RATE_LIMITED",
94474
+ "TIMEOUT",
94475
+ "SERVER_ERROR",
94476
+ "INVALID_RESPONSE",
94477
+ "ABORTED",
94478
+ "RESPONSE_TOO_LARGE",
94479
+ "REDIRECT_BLOCKED",
94480
+ "SCOPE_REQUIRED",
94481
+ "FORBIDDEN"
94482
+ ],
93967
94483
  [
93968
94484
  "BAD_REQUEST",
93969
94485
  "CONFIG_ERROR",
@@ -93972,13 +94488,16 @@
93972
94488
  "RATE_LIMITED",
93973
94489
  "VALIDATION_FAILED",
93974
94490
  "CONFLICT",
94491
+ "STALE_OBJECT",
93975
94492
  "TIMEOUT",
93976
94493
  "SERVER_ERROR",
93977
94494
  "INVALID_RESPONSE",
93978
94495
  "ABORTED",
93979
94496
  "RESPONSE_TOO_LARGE",
93980
94497
  "REDIRECT_BLOCKED",
93981
- "FORBIDDEN"
94498
+ "FORBIDDEN",
94499
+ "NOT_FOUND",
94500
+ "MAINTENANCE"
93982
94501
  ],
93983
94502
  [
93984
94503
  "BAD_REQUEST",
@@ -93986,13 +94505,14 @@
93986
94505
  "NETWORK_ERROR",
93987
94506
  "UNAUTHORIZED",
93988
94507
  "RATE_LIMITED",
94508
+ "VALIDATION_FAILED",
94509
+ "CONFLICT",
93989
94510
  "TIMEOUT",
93990
94511
  "SERVER_ERROR",
93991
94512
  "INVALID_RESPONSE",
93992
94513
  "ABORTED",
93993
94514
  "RESPONSE_TOO_LARGE",
93994
94515
  "REDIRECT_BLOCKED",
93995
- "SCOPE_REQUIRED",
93996
94516
  "FORBIDDEN"
93997
94517
  ],
93998
94518
  [