node-autotask 0.74.0 → 0.76.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 (39) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/MCP_TOOL_CATALOG.json +265 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +1219 -217
  5. package/dist/capabilities-data.js +1449 -447
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-HJKY7LUL.js → chunk-3SFIKG2R.js} +575 -215
  9. package/dist/{chunk-DSQJTGXK.cjs → chunk-55BQEFBO.cjs} +32 -30
  10. package/dist/{chunk-ASL3BIW2.cjs → chunk-C4S3EKIK.cjs} +3 -3
  11. package/dist/{chunk-IWTTCBCS.js → chunk-ECSE6B3U.js} +3 -3
  12. package/dist/{chunk-IFE5FWS7.js → chunk-S7QPD6TR.js} +2 -2
  13. package/dist/{chunk-PGSDJS52.js → chunk-UFK7JYYC.js} +4 -2
  14. package/dist/{chunk-AMB54GOO.cjs → chunk-Y4BH5N6R.cjs} +580 -220
  15. package/dist/{chunk-QZY5LAOG.cjs → chunk-YRTOAPWD.cjs} +199 -199
  16. package/dist/{index-CH65Ftmy.d.cts → index-BbAzrm2i.d.cts} +95 -1
  17. package/dist/{index-CH65Ftmy.d.ts → index-BbAzrm2i.d.ts} +95 -1
  18. package/dist/{index-ColCzIyw.d.ts → index-CY7exGOe.d.ts} +7 -8
  19. package/dist/{index-CkBDlaSS.d.cts → index-MY7qYY5d.d.cts} +7 -8
  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 +51 -51
  25. package/dist/operations/index.d.cts +4 -4
  26. package/dist/operations/index.d.ts +4 -4
  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 +4 -2
  39. package/package.json +1 -1
package/capabilities.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "generatedAt": "2026-11-19T01:02:15.564Z",
2
+ "generatedAt": "2026-11-19T03:48:00.887Z",
3
3
  "groups": {
4
4
  "B": {
5
- "planHash": "cff16b0b9d022a81a1926ffacb0d01cf5a1e924805447744b62865a3cf9d3779",
6
- "builtAt": "2026-11-19T01:02:15.553Z",
5
+ "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
6
+ "builtAt": "2026-11-19T03:48:00.874Z",
7
7
  "records": [
8
8
  {
9
9
  "id": "appointments.count",
@@ -42918,8 +42918,8 @@
42918
42918
  ]
42919
42919
  },
42920
42920
  "A": {
42921
- "planHash": "cff16b0b9d022a81a1926ffacb0d01cf5a1e924805447744b62865a3cf9d3779",
42922
- "builtAt": "2026-11-19T01:02:15.553Z",
42921
+ "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
42922
+ "builtAt": "2026-11-19T03:48:00.874Z",
42923
42923
  "records": [
42924
42924
  {
42925
42925
  "id": "attachment_info.count",
@@ -74538,12 +74538,12 @@
74538
74538
  "status": "tested"
74539
74539
  },
74540
74540
  {
74541
- "id": "task_notes.count",
74542
- "resource": "task_notes",
74541
+ "id": "task_attachments.count",
74542
+ "resource": "task_attachments",
74543
74543
  "udfCapable": false,
74544
74544
  "operation": "count",
74545
74545
  "kind": "primitive",
74546
- "endpoint": "GET|POST /V1.0/TaskNotes/query/count",
74546
+ "endpoint": "GET|POST /V1.0/TaskAttachments/query/count",
74547
74547
  "effect": "read",
74548
74548
  "flags": [],
74549
74549
  "dryRun": false,
@@ -74573,7 +74573,7 @@
74573
74573
  "drops": []
74574
74574
  },
74575
74575
  "examples": [
74576
- "await invoke(client, 'task_notes.count', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }] }])"
74576
+ "await invoke(client, 'task_attachments.count', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }] }])"
74577
74577
  ],
74578
74578
  "permissions": "unknown",
74579
74579
  "pagination": {
@@ -74584,18 +74584,17 @@
74584
74584
  "preset": "retry-ffb3a9cb"
74585
74585
  },
74586
74586
  "errors": {
74587
- "set": 0
74587
+ "set": 12
74588
74588
  },
74589
74589
  "metadata": {
74590
- "purpose": "Count task note records matching a JSON filter.",
74591
- "usage": "Unwraps queryCount; returns a plain number.",
74590
+ "purpose": "Count TaskAttachment records matching a task-scoped JSON filter.",
74591
+ "usage": "Unwraps queryCount; returns a plain number. Filter by taskID for task 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 common attachment changes contract permits child attachments in parent queries. A taskID match alone does not prove a direct task attachment, so createIfNotExists is refused; direct create remains available.",
74592
74592
  "preferredWhen": null,
74593
74593
  "related": [
74594
- "task_notes.query"
74594
+ "task_attachments.query"
74595
74595
  ],
74596
74596
  "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.",
74597
74597
  "untrustedFields": [
74598
- "description",
74599
74598
  "title"
74600
74599
  ]
74601
74600
  },
@@ -74603,12 +74602,12 @@
74603
74602
  "status": "tested"
74604
74603
  },
74605
74604
  {
74606
- "id": "task_notes.create",
74607
- "resource": "task_notes",
74605
+ "id": "task_attachments.create",
74606
+ "resource": "task_attachments",
74608
74607
  "udfCapable": false,
74609
74608
  "operation": "create",
74610
74609
  "kind": "primitive",
74611
- "endpoint": "POST /V1.0/Tasks/{parentId}/Notes",
74610
+ "endpoint": "POST /V1.0/Tasks/{parentId}/Attachments",
74612
74611
  "effect": "write",
74613
74612
  "flags": [],
74614
74613
  "dryRun": true,
@@ -74631,7 +74630,7 @@
74631
74630
  "drops": []
74632
74631
  },
74633
74632
  "examples": [
74634
- "const fields = await client.taskNotes.getFieldInfo();\nconst activeValue = (name) => {\n const field = fields.find(field => field.name === name && field.isPickList === true);\n const choice = field?.picklistValues?.find(choice => choice.isActive === true && typeof choice.value === 'string' && /^-?\\d+$/.test(choice.value) && Number.isSafeInteger(Number(choice.value)));\n if (!choice) throw new Error(`No active integer picklist choice is available for ${name}; check TaskNotes field metadata.`);\n return Number(choice.value);\n};\nconst noteType = activeValue('noteType');\nconst publish = activeValue('publish');\nawait client.taskNotes.create(7, { description: 'Work completed', title: 'Progress', noteType, publish, taskID: 7 }, { dryRun: true });"
74633
+ "await invoke(client, 'task_attachments.create', [7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: 1, data: 'bm90ZQ==' }], { dryRun: true })"
74635
74634
  ],
74636
74635
  "permissions": "unknown",
74637
74636
  "pagination": {
@@ -74642,39 +74641,49 @@
74642
74641
  "preset": "retry-c5657094"
74643
74642
  },
74644
74643
  "errors": {
74645
- "set": 1
74644
+ "set": 13
74646
74645
  },
74647
74646
  "metadata": {
74648
- "purpose": "Create a task note.",
74649
- "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. Description writes use plain text and can lose existing rich text/images. The create body must include taskID equal to the parentId path argument; official documentation does not establish that the URL fills this required field. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Contact impersonation requires permission, publish ALL (resolve its value from current metadata), an active contact and account, and a task belonging to the contact's account or a child account. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused. Create requires description, noteType, publish and taskID.",
74650
- "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
74647
+ "purpose": "Create an attachment under a task.",
74648
+ "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 Tasks record. Permission and impersonation restrictions apply. The required fields are attachmentType, fullPath, publish and title. For FILE_ATTACHMENT, data is a required non-empty base64 string. Resolve attachmentType/publish values from current metadata, not example integers. Resource impersonation uses the existing request header; the documented contact-impersonation parent list does not include direct Task attachments. Task attachments support parentAttachmentID nesting; this is not a new nested-attachment endpoint. taskNoteID, timeEntryID and opportunityID are read-only reference fields, not writable cross-object associations; legacy parentID and computed creatorType/fileSize are not create inputs.",
74649
+ "preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
74651
74650
  "related": [
74652
- "task_notes.update"
74651
+ "task_attachments.get"
74653
74652
  ],
74654
- "deleteBoundary": {
74655
- "resource": "task_notes",
74656
- "note": "The vendor defines no DELETE for task_notes (spec-derived); a created task note cannot be removed through the public API.",
74657
- "proof": "spec-derived"
74658
- },
74659
74653
  "untrustedFields": [
74660
- "description",
74661
74654
  "title"
74662
- ]
74655
+ ],
74656
+ "createRequirements": {
74657
+ "requiresByValue": [
74658
+ {
74659
+ "field": "attachmentType",
74660
+ "value": "FILE_ATTACHMENT",
74661
+ "requires": {
74662
+ "allOf": [
74663
+ "data"
74664
+ ]
74665
+ }
74666
+ }
74667
+ ]
74668
+ }
74663
74669
  },
74664
74670
  "compact": null,
74665
74671
  "status": "tested"
74666
74672
  },
74667
74673
  {
74668
- "id": "task_notes.get",
74669
- "resource": "task_notes",
74674
+ "id": "task_attachments.delete",
74675
+ "resource": "task_attachments",
74670
74676
  "udfCapable": false,
74671
- "operation": "get",
74677
+ "operation": "delete",
74672
74678
  "kind": "primitive",
74673
- "endpoint": "GET /V1.0/Tasks/{parentId}/Notes/{id}",
74674
- "effect": "read",
74675
- "flags": [],
74676
- "dryRun": false,
74677
- "envelope": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
74679
+ "endpoint": "DELETE /V1.0/Tasks/{parentId}/Attachments/{id}",
74680
+ "effect": "destructive",
74681
+ "flags": [
74682
+ "idempotent",
74683
+ "requiresApproval"
74684
+ ],
74685
+ "dryRun": true,
74686
+ "envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
74678
74687
  "inputSchema": {
74679
74688
  "parentId": {
74680
74689
  "type": "string | number",
@@ -74685,27 +74694,15 @@
74685
74694
  "type": "string | number",
74686
74695
  "required": true,
74687
74696
  "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
74688
- },
74689
- "opts": {
74690
- "type": "object",
74691
- "required": false,
74692
- "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.",
74693
- "properties": [
74694
- {
74695
- "name": "fresh",
74696
- "type": "boolean",
74697
- "optional": true
74698
- }
74699
- ]
74700
74697
  }
74701
74698
  },
74702
74699
  "inputSchemaStrict": true,
74703
74700
  "outputSchema": {
74704
- "type": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
74701
+ "type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
74705
74702
  "drops": []
74706
74703
  },
74707
74704
  "examples": [
74708
- "await client.taskNotes.get(7, 3)"
74705
+ "await invoke(client, 'task_attachments.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_attachments.delete' })"
74709
74706
  ],
74710
74707
  "permissions": "unknown",
74711
74708
  "pagination": {
@@ -74713,19 +74710,19 @@
74713
74710
  },
74714
74711
  "resolution": null,
74715
74712
  "retry": {
74716
- "preset": "retry-ffb3a9cb"
74713
+ "preset": "retry-1849870d"
74717
74714
  },
74718
74715
  "errors": {
74719
- "set": 3
74716
+ "set": 14
74720
74717
  },
74721
74718
  "metadata": {
74722
- "purpose": "Get one TaskNote by id.",
74723
- "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
74724
- "preferredWhen": "Preferred when the parent task ID and note ID are known; use a bounded taskID-filtered query to discover notes.",
74725
- "related": [],
74726
- "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 task_notes.query with includeFields.",
74719
+ "purpose": "Delete an attachment under a task.",
74720
+ "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
74721
+ "preferredWhen": null,
74722
+ "related": [
74723
+ "task_attachments.get"
74724
+ ],
74727
74725
  "untrustedFields": [
74728
- "description",
74729
74726
  "title"
74730
74727
  ]
74731
74728
  },
@@ -74733,24 +74730,47 @@
74733
74730
  "status": "tested"
74734
74731
  },
74735
74732
  {
74736
- "id": "task_notes.getEntityInfo",
74737
- "resource": "task_notes",
74733
+ "id": "task_attachments.get",
74734
+ "resource": "task_attachments",
74738
74735
  "udfCapable": false,
74739
- "operation": "getEntityInfo",
74736
+ "operation": "get",
74740
74737
  "kind": "primitive",
74741
- "endpoint": "GET /V1.0/TaskNotes/entityInformation",
74738
+ "endpoint": "GET /V1.0/Tasks/{parentId}/Attachments/{id}",
74742
74739
  "effect": "read",
74743
74740
  "flags": [],
74744
74741
  "dryRun": false,
74745
- "envelope": "EntityInformationResultModel",
74746
- "inputSchema": {},
74742
+ "envelope": "TaskAttachmentModel",
74743
+ "inputSchema": {
74744
+ "parentId": {
74745
+ "type": "string | number",
74746
+ "required": true,
74747
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
74748
+ },
74749
+ "id": {
74750
+ "type": "string | number",
74751
+ "required": true,
74752
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
74753
+ },
74754
+ "opts": {
74755
+ "type": "object",
74756
+ "required": false,
74757
+ "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.",
74758
+ "properties": [
74759
+ {
74760
+ "name": "fresh",
74761
+ "type": "boolean",
74762
+ "optional": true
74763
+ }
74764
+ ]
74765
+ }
74766
+ },
74747
74767
  "inputSchemaStrict": true,
74748
74768
  "outputSchema": {
74749
- "type": "EntityInformationResultModel",
74769
+ "type": "TaskAttachmentModel",
74750
74770
  "drops": []
74751
74771
  },
74752
74772
  "examples": [
74753
- "await client.taskNotes.getEntityInfo()"
74773
+ "await client.taskAttachments.get('example-value', 'example-value')"
74754
74774
  ],
74755
74775
  "permissions": "unknown",
74756
74776
  "pagination": {
@@ -74761,17 +74781,17 @@
74761
74781
  "preset": "retry-ffb3a9cb"
74762
74782
  },
74763
74783
  "errors": {
74764
- "set": 0
74784
+ "set": 3
74765
74785
  },
74766
74786
  "metadata": {
74767
- "purpose": "Get the TaskNote capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
74768
- "usage": "Unwraps info{}; drives client-side capability checks.",
74769
- "preferredWhen": null,
74787
+ "purpose": "Get one attachment by task ID and attachment ID.",
74788
+ "usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the task id, followed by the attachment id. A Tasks parent record is project-scoped elsewhere; do not substitute a project id or an attachment id for the task parent.",
74789
+ "preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
74770
74790
  "related": [
74771
- "task_notes.getFieldInfo"
74791
+ "task_attachments.query"
74772
74792
  ],
74793
+ "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 task_attachments.query with includeFields.",
74773
74794
  "untrustedFields": [
74774
- "description",
74775
74795
  "title"
74776
74796
  ]
74777
74797
  },
@@ -74779,24 +74799,24 @@
74779
74799
  "status": "tested"
74780
74800
  },
74781
74801
  {
74782
- "id": "task_notes.getFieldInfo",
74783
- "resource": "task_notes",
74802
+ "id": "task_attachments.getEntityInfo",
74803
+ "resource": "task_attachments",
74784
74804
  "udfCapable": false,
74785
- "operation": "getFieldInfo",
74805
+ "operation": "getEntityInfo",
74786
74806
  "kind": "primitive",
74787
- "endpoint": "GET /V1.0/TaskNotes/entityInformation/fields",
74807
+ "endpoint": "GET /V1.0/TaskAttachments/entityInformation",
74788
74808
  "effect": "read",
74789
74809
  "flags": [],
74790
74810
  "dryRun": false,
74791
- "envelope": "FieldInformationResultModel",
74811
+ "envelope": "EntityInformationResultModel",
74792
74812
  "inputSchema": {},
74793
74813
  "inputSchemaStrict": true,
74794
74814
  "outputSchema": {
74795
- "type": "FieldInformationResultModel",
74815
+ "type": "EntityInformationResultModel",
74796
74816
  "drops": []
74797
74817
  },
74798
74818
  "examples": [
74799
- "await client.taskNotes.getFieldInfo()"
74819
+ "await client.taskAttachments.getEntityInfo()"
74800
74820
  ],
74801
74821
  "permissions": "unknown",
74802
74822
  "pagination": {
@@ -74807,18 +74827,16 @@
74807
74827
  "preset": "retry-ffb3a9cb"
74808
74828
  },
74809
74829
  "errors": {
74810
- "set": 0
74830
+ "set": 12
74811
74831
  },
74812
74832
  "metadata": {
74813
- "purpose": "Get the TaskNote field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
74814
- "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.",
74833
+ "purpose": "Get the TaskAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
74834
+ "usage": "Unwraps info{}; drives client-side capability checks.",
74815
74835
  "preferredWhen": null,
74816
74836
  "related": [
74817
- "task_notes.getEntityInfo",
74818
- "task_notes.getUdfInfo"
74837
+ "task_attachments.getFieldInfo"
74819
74838
  ],
74820
74839
  "untrustedFields": [
74821
- "description",
74822
74840
  "title"
74823
74841
  ]
74824
74842
  },
@@ -74826,24 +74844,24 @@
74826
74844
  "status": "tested"
74827
74845
  },
74828
74846
  {
74829
- "id": "task_notes.getUdfInfo",
74830
- "resource": "task_notes",
74847
+ "id": "task_attachments.getFieldInfo",
74848
+ "resource": "task_attachments",
74831
74849
  "udfCapable": false,
74832
- "operation": "getUdfInfo",
74850
+ "operation": "getFieldInfo",
74833
74851
  "kind": "primitive",
74834
- "endpoint": "GET /V1.0/TaskNotes/entityInformation/userDefinedFields",
74852
+ "endpoint": "GET /V1.0/TaskAttachments/entityInformation/fields",
74835
74853
  "effect": "read",
74836
74854
  "flags": [],
74837
74855
  "dryRun": false,
74838
- "envelope": "UserDefinedFieldInformationResultModel",
74856
+ "envelope": "FieldInformationResultModel",
74839
74857
  "inputSchema": {},
74840
74858
  "inputSchemaStrict": true,
74841
74859
  "outputSchema": {
74842
- "type": "UserDefinedFieldInformationResultModel",
74860
+ "type": "FieldInformationResultModel",
74843
74861
  "drops": []
74844
74862
  },
74845
74863
  "examples": [
74846
- "await client.taskNotes.getUdfInfo()"
74864
+ "await client.taskAttachments.getFieldInfo()"
74847
74865
  ],
74848
74866
  "permissions": "unknown",
74849
74867
  "pagination": {
@@ -74854,17 +74872,16 @@
74854
74872
  "preset": "retry-ffb3a9cb"
74855
74873
  },
74856
74874
  "errors": {
74857
- "set": 0
74875
+ "set": 12
74858
74876
  },
74859
74877
  "metadata": {
74860
- "purpose": "Get the TaskNote user-defined-field catalog.",
74861
- "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
74878
+ "purpose": "Get the TaskAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
74879
+ "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.",
74862
74880
  "preferredWhen": null,
74863
74881
  "related": [
74864
- "task_notes.getFieldInfo"
74882
+ "task_attachments.getEntityInfo"
74865
74883
  ],
74866
74884
  "untrustedFields": [
74867
- "description",
74868
74885
  "title"
74869
74886
  ]
74870
74887
  },
@@ -74872,12 +74889,12 @@
74872
74889
  "status": "tested"
74873
74890
  },
74874
74891
  {
74875
- "id": "task_notes.query",
74876
- "resource": "task_notes",
74892
+ "id": "task_attachments.query",
74893
+ "resource": "task_attachments",
74877
74894
  "udfCapable": false,
74878
74895
  "operation": "query",
74879
74896
  "kind": "primitive",
74880
- "endpoint": "GET|POST /V1.0/TaskNotes/query",
74897
+ "endpoint": "GET|POST /V1.0/TaskAttachments/query",
74881
74898
  "effect": "read",
74882
74899
  "flags": [],
74883
74900
  "dryRun": false,
@@ -74949,7 +74966,7 @@
74949
74966
  "drops": []
74950
74967
  },
74951
74968
  "examples": [
74952
- "await invoke(client, 'task_notes.query', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }], limit: 25 }])"
74969
+ "await invoke(client, 'task_attachments.query', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }], limit: 25 }])"
74953
74970
  ],
74954
74971
  "permissions": "unknown",
74955
74972
  "pagination": {
@@ -74967,80 +74984,17 @@
74967
74984
  "preset": "retry-ffb3a9cb"
74968
74985
  },
74969
74986
  "errors": {
74970
- "set": 4
74987
+ "set": 15
74971
74988
  },
74972
74989
  "metadata": {
74973
- "purpose": "Query TaskNote records with a JSON filter.",
74974
- "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 taskID 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.",
74990
+ "purpose": "Query TaskAttachment records with a JSON filter.",
74991
+ "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 taskID 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 taskID for task 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. The common attachment changes contract permits child attachments in parent queries. A taskID match alone does not prove a direct task attachment, so createIfNotExists is refused; direct create remains available.",
74975
74992
  "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).",
74976
- "related": [],
74977
- "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.",
74978
- "untrustedFields": [
74979
- "description",
74980
- "title"
74981
- ]
74982
- },
74983
- "compact": null,
74984
- "status": "tested"
74985
- },
74986
- {
74987
- "id": "task_notes.update",
74988
- "resource": "task_notes",
74989
- "udfCapable": false,
74990
- "operation": "update",
74991
- "kind": "primitive",
74992
- "endpoint": "PUT|PATCH /V1.0/Tasks/{parentId}/Notes",
74993
- "effect": "write",
74994
- "flags": [
74995
- "idempotent"
74996
- ],
74997
- "dryRun": true,
74998
- "envelope": "OperationResultModel",
74999
- "inputSchema": {
75000
- "parentId": {
75001
- "type": "string | number",
75002
- "required": true,
75003
- "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
75004
- },
75005
- "id": {
75006
- "type": "string | number",
75007
- "required": true,
75008
- "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
75009
- },
75010
- "data": {
75011
- "type": "object",
75012
- "required": true,
75013
- "description": "The record payload (vendor model fields)."
75014
- }
75015
- },
75016
- "inputSchemaStrict": true,
75017
- "outputSchema": {
75018
- "type": "OperationResultModel",
75019
- "drops": []
75020
- },
75021
- "examples": [
75022
- "await client.taskNotes.update(7, 3, { description: 'Updated progress' }, { dryRun: true })"
75023
- ],
75024
- "permissions": "unknown",
75025
- "pagination": {
75026
- "mode": "none"
75027
- },
75028
- "resolution": null,
75029
- "retry": {
75030
- "preset": "retry-85897a3a"
75031
- },
75032
- "errors": {
75033
- "set": 1
75034
- },
75035
- "metadata": {
75036
- "purpose": "Update a task note.",
75037
- "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). TaskNoteModel has no supported lastModifiedDate stale token; preview reads a fresh record, without promising an atomic vendor precondition. Parent-scoped: parentId + id. Description writes use plain text and can lose existing rich text/images. Parent taskID is the path argument; a supplied taskID must match. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused.",
75038
- "preferredWhen": "Use when an existing task note needs a supported field change.",
75039
74993
  "related": [
75040
- "task_notes.get"
74994
+ "task_attachments.get"
75041
74995
  ],
74996
+ "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.",
75042
74997
  "untrustedFields": [
75043
- "description",
75044
74998
  "title"
75045
74999
  ]
75046
75000
  },
@@ -75048,12 +75002,12 @@
75048
75002
  "status": "tested"
75049
75003
  },
75050
75004
  {
75051
- "id": "task_predecessors.count",
75052
- "resource": "task_predecessors",
75005
+ "id": "task_note_attachments.count",
75006
+ "resource": "task_note_attachments",
75053
75007
  "udfCapable": false,
75054
75008
  "operation": "count",
75055
75009
  "kind": "primitive",
75056
- "endpoint": "GET|POST /V1.0/TaskPredecessors/query/count",
75010
+ "endpoint": "GET|POST /V1.0/TaskNoteAttachments/query/count",
75057
75011
  "effect": "read",
75058
75012
  "flags": [],
75059
75013
  "dryRun": false,
@@ -75083,7 +75037,7 @@
75083
75037
  "drops": []
75084
75038
  },
75085
75039
  "examples": [
75086
- "await invoke(client, 'task_predecessors.count', [{ filter: [{ field: 'successorTaskID', op: 'eq', value: 7 }] }])"
75040
+ "await invoke(client, 'task_note_attachments.count', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }] }])"
75087
75041
  ],
75088
75042
  "permissions": "unknown",
75089
75043
  "pagination": {
@@ -75097,24 +75051,27 @@
75097
75051
  "set": 0
75098
75052
  },
75099
75053
  "metadata": {
75100
- "purpose": "Count task predecessor relationships matching a JSON filter.",
75101
- "usage": "Unwraps queryCount; returns a plain number.",
75054
+ "purpose": "Count task note attachment records matching a JSON filter. Use taskNoteID for note scope.",
75055
+ "usage": "Unwraps queryCount; returns a plain number. Include an object-specific taskNoteID filter. taskID is the separate task association; taskNoteID identifies the note parent. Do not substitute the task id for the note id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility.",
75102
75056
  "preferredWhen": null,
75103
75057
  "related": [
75104
- "task_predecessors.query"
75058
+ "task_note_attachments.query"
75105
75059
  ],
75106
- "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."
75060
+ "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.",
75061
+ "untrustedFields": [
75062
+ "title"
75063
+ ]
75107
75064
  },
75108
75065
  "compact": null,
75109
75066
  "status": "tested"
75110
75067
  },
75111
75068
  {
75112
- "id": "task_predecessors.create",
75113
- "resource": "task_predecessors",
75069
+ "id": "task_note_attachments.create",
75070
+ "resource": "task_note_attachments",
75114
75071
  "udfCapable": false,
75115
75072
  "operation": "create",
75116
75073
  "kind": "primitive",
75117
- "endpoint": "POST /V1.0/Tasks/{parentId}/Predecessors",
75074
+ "endpoint": "POST /V1.0/TaskNotes/{parentId}/Attachments",
75118
75075
  "effect": "write",
75119
75076
  "flags": [],
75120
75077
  "dryRun": true,
@@ -75137,7 +75094,7 @@
75137
75094
  "drops": []
75138
75095
  },
75139
75096
  "examples": [
75140
- "await client.taskPredecessors.create(7, { predecessorTaskID: 8, successorTaskID: 7, lagDays: 2 }, { dryRun: true })"
75097
+ "const fields = await client.taskNoteAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.taskNoteAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
75141
75098
  ],
75142
75099
  "permissions": "unknown",
75143
75100
  "pagination": {
@@ -75151,28 +75108,58 @@
75151
75108
  "set": 1
75152
75109
  },
75153
75110
  "metadata": {
75154
- "purpose": "create task predecessor relationships.",
75155
- "usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
75156
- "preferredWhen": null,
75157
- "related": []
75111
+ "purpose": "Create a file attachment under a task note.",
75112
+ "usage": "Create a file under TaskNotes/{parentId}/Attachments; parentId is the task-note ID, not taskID. Required: explicit FILE_ATTACHMENT, title/fullPath (at most 255 characters), numeric publish from current metadata and base64 data. Existing attachments cannot be updated. taskID/taskNoteID and audit fields are response associations, not writable links. Vendor file/type limits and permissions apply: individual file limit 6–7 MB, 10,000,000 bytes per five minutes and a five-minute creation pause when exceeded. Contact impersonation requires security permission, publish label ALL, an active contact/account, and a note created by that contact. Resource impersonation uses the configured header. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
75113
+ "preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
75114
+ "related": [
75115
+ "task_note_attachments.get"
75116
+ ],
75117
+ "argNotes": {
75118
+ "data": "File uploads only. Optional attachedByContactID is the documented contact impersonation input; the vendor checks authorship of the task note, active contact/account, publish ALL and security permission. Read-only taskID/taskNoteID, audit/creator fields, contentType and fileSize are not create inputs. No parentAttachmentID on this model; nested attachments use the parent entity URL and do not retain note visibility. Other attachment types and UDF writes are unsupported."
75119
+ },
75120
+ "untrustedFields": [
75121
+ "title"
75122
+ ],
75123
+ "createRequirements": {
75124
+ "requires": {
75125
+ "allOf": [
75126
+ "attachmentType",
75127
+ "fullPath",
75128
+ "title",
75129
+ "publish",
75130
+ "data"
75131
+ ]
75132
+ },
75133
+ "requiresByValue": [
75134
+ {
75135
+ "field": "attachmentType",
75136
+ "value": "FILE_ATTACHMENT",
75137
+ "requires": {
75138
+ "allOf": [
75139
+ "data"
75140
+ ]
75141
+ }
75142
+ }
75143
+ ]
75144
+ }
75158
75145
  },
75159
75146
  "compact": null,
75160
75147
  "status": "tested"
75161
75148
  },
75162
75149
  {
75163
- "id": "task_predecessors.delete",
75164
- "resource": "task_predecessors",
75150
+ "id": "task_note_attachments.delete",
75151
+ "resource": "task_note_attachments",
75165
75152
  "udfCapable": false,
75166
75153
  "operation": "delete",
75167
75154
  "kind": "primitive",
75168
- "endpoint": "DELETE /V1.0/Tasks/{parentId}/Predecessors/{id}",
75155
+ "endpoint": "DELETE /V1.0/TaskNotes/{parentId}/Attachments/{id}",
75169
75156
  "effect": "destructive",
75170
75157
  "flags": [
75171
75158
  "idempotent",
75172
75159
  "requiresApproval"
75173
75160
  ],
75174
75161
  "dryRun": true,
75175
- "envelope": "OperationResultModel",
75162
+ "envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
75176
75163
  "inputSchema": {
75177
75164
  "parentId": {
75178
75165
  "type": "string | number",
@@ -75187,11 +75174,11 @@
75187
75174
  },
75188
75175
  "inputSchemaStrict": true,
75189
75176
  "outputSchema": {
75190
- "type": "OperationResultModel",
75177
+ "type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
75191
75178
  "drops": []
75192
75179
  },
75193
75180
  "examples": [
75194
- "await invoke(client, 'task_predecessors.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_predecessors.delete' })"
75181
+ "await invoke(client, 'task_note_attachments.delete', [7, 3], { confirm: 'task_note_attachments.delete' })"
75195
75182
  ],
75196
75183
  "permissions": "unknown",
75197
75184
  "pagination": {
@@ -75205,27 +75192,980 @@
75205
75192
  "set": 2
75206
75193
  },
75207
75194
  "metadata": {
75208
- "purpose": "Delete one task predecessor relationship.",
75209
- "usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token. Destructive invocation requires exact operation confirmation. Preview sends no mutation.",
75195
+ "purpose": "Delete an attachment under a task note.",
75196
+ "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
75210
75197
  "preferredWhen": null,
75211
75198
  "related": [
75212
- "task_predecessors.get"
75199
+ "task_note_attachments.get"
75200
+ ],
75201
+ "untrustedFields": [
75202
+ "title"
75213
75203
  ]
75214
75204
  },
75215
75205
  "compact": null,
75216
75206
  "status": "tested"
75217
75207
  },
75218
75208
  {
75219
- "id": "task_predecessors.get",
75220
- "resource": "task_predecessors",
75209
+ "id": "task_note_attachments.get",
75210
+ "resource": "task_note_attachments",
75221
75211
  "udfCapable": false,
75222
75212
  "operation": "get",
75223
75213
  "kind": "primitive",
75224
- "endpoint": "GET /V1.0/Tasks/{parentId}/Predecessors/{id}",
75214
+ "endpoint": "GET /V1.0/TaskNotes/{parentId}/Attachments/{id}",
75225
75215
  "effect": "read",
75226
75216
  "flags": [],
75227
75217
  "dryRun": false,
75228
- "envelope": "ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]",
75218
+ "envelope": "TaskNoteAttachmentModel",
75219
+ "inputSchema": {
75220
+ "parentId": {
75221
+ "type": "string | number",
75222
+ "required": true,
75223
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
75224
+ },
75225
+ "id": {
75226
+ "type": "string | number",
75227
+ "required": true,
75228
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
75229
+ },
75230
+ "opts": {
75231
+ "type": "object",
75232
+ "required": false,
75233
+ "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.",
75234
+ "properties": [
75235
+ {
75236
+ "name": "fresh",
75237
+ "type": "boolean",
75238
+ "optional": true
75239
+ }
75240
+ ]
75241
+ }
75242
+ },
75243
+ "inputSchemaStrict": true,
75244
+ "outputSchema": {
75245
+ "type": "TaskNoteAttachmentModel",
75246
+ "drops": []
75247
+ },
75248
+ "examples": [
75249
+ "await client.taskNoteAttachments.get(7, 3)"
75250
+ ],
75251
+ "permissions": "unknown",
75252
+ "pagination": {
75253
+ "mode": "none"
75254
+ },
75255
+ "resolution": null,
75256
+ "retry": {
75257
+ "preset": "retry-ffb3a9cb"
75258
+ },
75259
+ "errors": {
75260
+ "set": 3
75261
+ },
75262
+ "metadata": {
75263
+ "purpose": "Get one TaskNoteAttachment by id.",
75264
+ "usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the task-note id, followed by the attachment id.",
75265
+ "preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
75266
+ "related": [
75267
+ "task_note_attachments.query"
75268
+ ],
75269
+ "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 task_note_attachments.query with includeFields.",
75270
+ "untrustedFields": [
75271
+ "title"
75272
+ ]
75273
+ },
75274
+ "compact": null,
75275
+ "status": "tested"
75276
+ },
75277
+ {
75278
+ "id": "task_note_attachments.getEntityInfo",
75279
+ "resource": "task_note_attachments",
75280
+ "udfCapable": false,
75281
+ "operation": "getEntityInfo",
75282
+ "kind": "primitive",
75283
+ "endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation",
75284
+ "effect": "read",
75285
+ "flags": [],
75286
+ "dryRun": false,
75287
+ "envelope": "EntityInformationResultModel",
75288
+ "inputSchema": {},
75289
+ "inputSchemaStrict": true,
75290
+ "outputSchema": {
75291
+ "type": "EntityInformationResultModel",
75292
+ "drops": []
75293
+ },
75294
+ "examples": [
75295
+ "await client.taskNoteAttachments.getEntityInfo()"
75296
+ ],
75297
+ "permissions": "unknown",
75298
+ "pagination": {
75299
+ "mode": "none"
75300
+ },
75301
+ "resolution": null,
75302
+ "retry": {
75303
+ "preset": "retry-ffb3a9cb"
75304
+ },
75305
+ "errors": {
75306
+ "set": 0
75307
+ },
75308
+ "metadata": {
75309
+ "purpose": "Get the TaskNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
75310
+ "usage": "Unwraps info{}; drives client-side capability checks.",
75311
+ "preferredWhen": null,
75312
+ "related": [
75313
+ "task_note_attachments.getFieldInfo"
75314
+ ],
75315
+ "untrustedFields": [
75316
+ "title"
75317
+ ]
75318
+ },
75319
+ "compact": null,
75320
+ "status": "tested"
75321
+ },
75322
+ {
75323
+ "id": "task_note_attachments.getFieldInfo",
75324
+ "resource": "task_note_attachments",
75325
+ "udfCapable": false,
75326
+ "operation": "getFieldInfo",
75327
+ "kind": "primitive",
75328
+ "endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation/fields",
75329
+ "effect": "read",
75330
+ "flags": [],
75331
+ "dryRun": false,
75332
+ "envelope": "FieldInformationResultModel",
75333
+ "inputSchema": {},
75334
+ "inputSchemaStrict": true,
75335
+ "outputSchema": {
75336
+ "type": "FieldInformationResultModel",
75337
+ "drops": []
75338
+ },
75339
+ "examples": [
75340
+ "await client.taskNoteAttachments.getFieldInfo()"
75341
+ ],
75342
+ "permissions": "unknown",
75343
+ "pagination": {
75344
+ "mode": "none"
75345
+ },
75346
+ "resolution": null,
75347
+ "retry": {
75348
+ "preset": "retry-ffb3a9cb"
75349
+ },
75350
+ "errors": {
75351
+ "set": 0
75352
+ },
75353
+ "metadata": {
75354
+ "purpose": "Get the TaskNoteAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
75355
+ "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.",
75356
+ "preferredWhen": null,
75357
+ "related": [
75358
+ "task_note_attachments.getEntityInfo"
75359
+ ],
75360
+ "untrustedFields": [
75361
+ "title"
75362
+ ]
75363
+ },
75364
+ "compact": null,
75365
+ "status": "tested"
75366
+ },
75367
+ {
75368
+ "id": "task_note_attachments.query",
75369
+ "resource": "task_note_attachments",
75370
+ "udfCapable": false,
75371
+ "operation": "query",
75372
+ "kind": "primitive",
75373
+ "endpoint": "GET|POST /V1.0/TaskNoteAttachments/query",
75374
+ "effect": "read",
75375
+ "flags": [],
75376
+ "dryRun": false,
75377
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
75378
+ "inputSchema": {
75379
+ "params": {
75380
+ "type": "object",
75381
+ "required": false,
75382
+ "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.",
75383
+ "properties": [
75384
+ {
75385
+ "name": "filter",
75386
+ "type": "FilterCondition[]",
75387
+ "optional": true
75388
+ },
75389
+ {
75390
+ "name": "limit",
75391
+ "type": "number",
75392
+ "optional": true,
75393
+ "default": 500
75394
+ },
75395
+ {
75396
+ "name": "latest",
75397
+ "type": "number",
75398
+ "optional": true
75399
+ },
75400
+ {
75401
+ "name": "noteChars",
75402
+ "type": "number",
75403
+ "optional": true
75404
+ },
75405
+ {
75406
+ "name": "includeFields",
75407
+ "type": "string[]",
75408
+ "optional": true
75409
+ },
75410
+ {
75411
+ "name": "fieldCheck",
75412
+ "type": "boolean",
75413
+ "optional": true,
75414
+ "default": true
75415
+ },
75416
+ {
75417
+ "name": "names",
75418
+ "type": "boolean",
75419
+ "optional": true
75420
+ },
75421
+ {
75422
+ "name": "via",
75423
+ "type": "\"post\" | \"get\"",
75424
+ "optional": true
75425
+ },
75426
+ {
75427
+ "name": "acknowledgeUnscoped",
75428
+ "type": "boolean",
75429
+ "optional": true
75430
+ },
75431
+ {
75432
+ "name": "walk",
75433
+ "type": "object",
75434
+ "optional": true
75435
+ }
75436
+ ]
75437
+ }
75438
+ },
75439
+ "inputSchemaStrict": true,
75440
+ "outputSchema": {
75441
+ "type": "QueryActionResult[<Model>,<Entity>]",
75442
+ "drops": []
75443
+ },
75444
+ "examples": [
75445
+ "await invoke(client, 'task_note_attachments.query', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }], limit: 25 }])"
75446
+ ],
75447
+ "permissions": "unknown",
75448
+ "pagination": {
75449
+ "mode": "cursor",
75450
+ "vendorDefault": 10,
75451
+ "vendorMax": 500,
75452
+ "pageGuard": 1000,
75453
+ "queryBounded": {
75454
+ "default": 500,
75455
+ "max": 2500
75456
+ }
75457
+ },
75458
+ "resolution": null,
75459
+ "retry": {
75460
+ "preset": "retry-ffb3a9cb"
75461
+ },
75462
+ "errors": {
75463
+ "set": 4
75464
+ },
75465
+ "metadata": {
75466
+ "purpose": "Query TaskNoteAttachment records with a JSON filter.",
75467
+ "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 taskNoteID 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. Include an object-specific taskNoteID filter. taskID is the separate task association; taskNoteID identifies the note parent. Do not substitute the task id for the note id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; 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.",
75468
+ "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).",
75469
+ "related": [
75470
+ "task_note_attachments.get"
75471
+ ],
75472
+ "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.",
75473
+ "untrustedFields": [
75474
+ "title"
75475
+ ]
75476
+ },
75477
+ "compact": null,
75478
+ "status": "tested"
75479
+ },
75480
+ {
75481
+ "id": "task_notes.count",
75482
+ "resource": "task_notes",
75483
+ "udfCapable": false,
75484
+ "operation": "count",
75485
+ "kind": "primitive",
75486
+ "endpoint": "GET|POST /V1.0/TaskNotes/query/count",
75487
+ "effect": "read",
75488
+ "flags": [],
75489
+ "dryRun": false,
75490
+ "envelope": "QueryCountResultModel",
75491
+ "inputSchema": {
75492
+ "params": {
75493
+ "type": "object",
75494
+ "required": false,
75495
+ "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.",
75496
+ "properties": [
75497
+ {
75498
+ "name": "filter",
75499
+ "type": "FilterCondition[]",
75500
+ "optional": true
75501
+ },
75502
+ {
75503
+ "name": "fieldCheck",
75504
+ "type": "boolean",
75505
+ "optional": true
75506
+ }
75507
+ ]
75508
+ }
75509
+ },
75510
+ "inputSchemaStrict": true,
75511
+ "outputSchema": {
75512
+ "type": "QueryCountResultModel",
75513
+ "drops": []
75514
+ },
75515
+ "examples": [
75516
+ "await invoke(client, 'task_notes.count', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }] }])"
75517
+ ],
75518
+ "permissions": "unknown",
75519
+ "pagination": {
75520
+ "mode": "none"
75521
+ },
75522
+ "resolution": null,
75523
+ "retry": {
75524
+ "preset": "retry-ffb3a9cb"
75525
+ },
75526
+ "errors": {
75527
+ "set": 0
75528
+ },
75529
+ "metadata": {
75530
+ "purpose": "Count task note records matching a JSON filter.",
75531
+ "usage": "Unwraps queryCount; returns a plain number.",
75532
+ "preferredWhen": null,
75533
+ "related": [
75534
+ "task_notes.query"
75535
+ ],
75536
+ "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.",
75537
+ "untrustedFields": [
75538
+ "description",
75539
+ "title"
75540
+ ]
75541
+ },
75542
+ "compact": null,
75543
+ "status": "tested"
75544
+ },
75545
+ {
75546
+ "id": "task_notes.create",
75547
+ "resource": "task_notes",
75548
+ "udfCapable": false,
75549
+ "operation": "create",
75550
+ "kind": "primitive",
75551
+ "endpoint": "POST /V1.0/Tasks/{parentId}/Notes",
75552
+ "effect": "write",
75553
+ "flags": [],
75554
+ "dryRun": true,
75555
+ "envelope": "OperationResultModel",
75556
+ "inputSchema": {
75557
+ "parentId": {
75558
+ "type": "string | number",
75559
+ "required": true,
75560
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
75561
+ },
75562
+ "data": {
75563
+ "type": "object",
75564
+ "required": true,
75565
+ "description": "The record payload (vendor model fields)."
75566
+ }
75567
+ },
75568
+ "inputSchemaStrict": true,
75569
+ "outputSchema": {
75570
+ "type": "OperationResultModel",
75571
+ "drops": []
75572
+ },
75573
+ "examples": [
75574
+ "const fields = await client.taskNotes.getFieldInfo();\nconst activeValue = (name) => {\n const field = fields.find(field => field.name === name && field.isPickList === true);\n const choice = field?.picklistValues?.find(choice => choice.isActive === true && typeof choice.value === 'string' && /^-?\\d+$/.test(choice.value) && Number.isSafeInteger(Number(choice.value)));\n if (!choice) throw new Error(`No active integer picklist choice is available for ${name}; check TaskNotes field metadata.`);\n return Number(choice.value);\n};\nconst noteType = activeValue('noteType');\nconst publish = activeValue('publish');\nawait client.taskNotes.create(7, { description: 'Work completed', title: 'Progress', noteType, publish, taskID: 7 }, { dryRun: true });"
75575
+ ],
75576
+ "permissions": "unknown",
75577
+ "pagination": {
75578
+ "mode": "none"
75579
+ },
75580
+ "resolution": null,
75581
+ "retry": {
75582
+ "preset": "retry-c5657094"
75583
+ },
75584
+ "errors": {
75585
+ "set": 1
75586
+ },
75587
+ "metadata": {
75588
+ "purpose": "Create a task note.",
75589
+ "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. Description writes use plain text and can lose existing rich text/images. The create body must include taskID equal to the parentId path argument; official documentation does not establish that the URL fills this required field. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Contact impersonation requires permission, publish ALL (resolve its value from current metadata), an active contact and account, and a task belonging to the contact's account or a child account. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused. Create requires description, noteType, publish and taskID.",
75590
+ "preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
75591
+ "related": [
75592
+ "task_notes.update"
75593
+ ],
75594
+ "deleteBoundary": {
75595
+ "resource": "task_notes",
75596
+ "note": "The vendor defines no DELETE for task_notes (spec-derived); a created task note cannot be removed through the public API.",
75597
+ "proof": "spec-derived"
75598
+ },
75599
+ "untrustedFields": [
75600
+ "description",
75601
+ "title"
75602
+ ]
75603
+ },
75604
+ "compact": null,
75605
+ "status": "tested"
75606
+ },
75607
+ {
75608
+ "id": "task_notes.get",
75609
+ "resource": "task_notes",
75610
+ "udfCapable": false,
75611
+ "operation": "get",
75612
+ "kind": "primitive",
75613
+ "endpoint": "GET /V1.0/Tasks/{parentId}/Notes/{id}",
75614
+ "effect": "read",
75615
+ "flags": [],
75616
+ "dryRun": false,
75617
+ "envelope": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
75618
+ "inputSchema": {
75619
+ "parentId": {
75620
+ "type": "string | number",
75621
+ "required": true,
75622
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
75623
+ },
75624
+ "id": {
75625
+ "type": "string | number",
75626
+ "required": true,
75627
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
75628
+ },
75629
+ "opts": {
75630
+ "type": "object",
75631
+ "required": false,
75632
+ "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.",
75633
+ "properties": [
75634
+ {
75635
+ "name": "fresh",
75636
+ "type": "boolean",
75637
+ "optional": true
75638
+ }
75639
+ ]
75640
+ }
75641
+ },
75642
+ "inputSchemaStrict": true,
75643
+ "outputSchema": {
75644
+ "type": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
75645
+ "drops": []
75646
+ },
75647
+ "examples": [
75648
+ "await client.taskNotes.get(7, 3)"
75649
+ ],
75650
+ "permissions": "unknown",
75651
+ "pagination": {
75652
+ "mode": "none"
75653
+ },
75654
+ "resolution": null,
75655
+ "retry": {
75656
+ "preset": "retry-ffb3a9cb"
75657
+ },
75658
+ "errors": {
75659
+ "set": 3
75660
+ },
75661
+ "metadata": {
75662
+ "purpose": "Get one TaskNote by id.",
75663
+ "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
75664
+ "preferredWhen": "Preferred when the parent task ID and note ID are known; use a bounded taskID-filtered query to discover notes.",
75665
+ "related": [],
75666
+ "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 task_notes.query with includeFields.",
75667
+ "untrustedFields": [
75668
+ "description",
75669
+ "title"
75670
+ ]
75671
+ },
75672
+ "compact": null,
75673
+ "status": "tested"
75674
+ },
75675
+ {
75676
+ "id": "task_notes.getEntityInfo",
75677
+ "resource": "task_notes",
75678
+ "udfCapable": false,
75679
+ "operation": "getEntityInfo",
75680
+ "kind": "primitive",
75681
+ "endpoint": "GET /V1.0/TaskNotes/entityInformation",
75682
+ "effect": "read",
75683
+ "flags": [],
75684
+ "dryRun": false,
75685
+ "envelope": "EntityInformationResultModel",
75686
+ "inputSchema": {},
75687
+ "inputSchemaStrict": true,
75688
+ "outputSchema": {
75689
+ "type": "EntityInformationResultModel",
75690
+ "drops": []
75691
+ },
75692
+ "examples": [
75693
+ "await client.taskNotes.getEntityInfo()"
75694
+ ],
75695
+ "permissions": "unknown",
75696
+ "pagination": {
75697
+ "mode": "none"
75698
+ },
75699
+ "resolution": null,
75700
+ "retry": {
75701
+ "preset": "retry-ffb3a9cb"
75702
+ },
75703
+ "errors": {
75704
+ "set": 0
75705
+ },
75706
+ "metadata": {
75707
+ "purpose": "Get the TaskNote capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
75708
+ "usage": "Unwraps info{}; drives client-side capability checks.",
75709
+ "preferredWhen": null,
75710
+ "related": [
75711
+ "task_notes.getFieldInfo"
75712
+ ],
75713
+ "untrustedFields": [
75714
+ "description",
75715
+ "title"
75716
+ ]
75717
+ },
75718
+ "compact": null,
75719
+ "status": "tested"
75720
+ },
75721
+ {
75722
+ "id": "task_notes.getFieldInfo",
75723
+ "resource": "task_notes",
75724
+ "udfCapable": false,
75725
+ "operation": "getFieldInfo",
75726
+ "kind": "primitive",
75727
+ "endpoint": "GET /V1.0/TaskNotes/entityInformation/fields",
75728
+ "effect": "read",
75729
+ "flags": [],
75730
+ "dryRun": false,
75731
+ "envelope": "FieldInformationResultModel",
75732
+ "inputSchema": {},
75733
+ "inputSchemaStrict": true,
75734
+ "outputSchema": {
75735
+ "type": "FieldInformationResultModel",
75736
+ "drops": []
75737
+ },
75738
+ "examples": [
75739
+ "await client.taskNotes.getFieldInfo()"
75740
+ ],
75741
+ "permissions": "unknown",
75742
+ "pagination": {
75743
+ "mode": "none"
75744
+ },
75745
+ "resolution": null,
75746
+ "retry": {
75747
+ "preset": "retry-ffb3a9cb"
75748
+ },
75749
+ "errors": {
75750
+ "set": 0
75751
+ },
75752
+ "metadata": {
75753
+ "purpose": "Get the TaskNote field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
75754
+ "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.",
75755
+ "preferredWhen": null,
75756
+ "related": [
75757
+ "task_notes.getEntityInfo",
75758
+ "task_notes.getUdfInfo"
75759
+ ],
75760
+ "untrustedFields": [
75761
+ "description",
75762
+ "title"
75763
+ ]
75764
+ },
75765
+ "compact": null,
75766
+ "status": "tested"
75767
+ },
75768
+ {
75769
+ "id": "task_notes.getUdfInfo",
75770
+ "resource": "task_notes",
75771
+ "udfCapable": false,
75772
+ "operation": "getUdfInfo",
75773
+ "kind": "primitive",
75774
+ "endpoint": "GET /V1.0/TaskNotes/entityInformation/userDefinedFields",
75775
+ "effect": "read",
75776
+ "flags": [],
75777
+ "dryRun": false,
75778
+ "envelope": "UserDefinedFieldInformationResultModel",
75779
+ "inputSchema": {},
75780
+ "inputSchemaStrict": true,
75781
+ "outputSchema": {
75782
+ "type": "UserDefinedFieldInformationResultModel",
75783
+ "drops": []
75784
+ },
75785
+ "examples": [
75786
+ "await client.taskNotes.getUdfInfo()"
75787
+ ],
75788
+ "permissions": "unknown",
75789
+ "pagination": {
75790
+ "mode": "none"
75791
+ },
75792
+ "resolution": null,
75793
+ "retry": {
75794
+ "preset": "retry-ffb3a9cb"
75795
+ },
75796
+ "errors": {
75797
+ "set": 0
75798
+ },
75799
+ "metadata": {
75800
+ "purpose": "Get the TaskNote user-defined-field catalog.",
75801
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
75802
+ "preferredWhen": null,
75803
+ "related": [
75804
+ "task_notes.getFieldInfo"
75805
+ ],
75806
+ "untrustedFields": [
75807
+ "description",
75808
+ "title"
75809
+ ]
75810
+ },
75811
+ "compact": null,
75812
+ "status": "tested"
75813
+ },
75814
+ {
75815
+ "id": "task_notes.query",
75816
+ "resource": "task_notes",
75817
+ "udfCapable": false,
75818
+ "operation": "query",
75819
+ "kind": "primitive",
75820
+ "endpoint": "GET|POST /V1.0/TaskNotes/query",
75821
+ "effect": "read",
75822
+ "flags": [],
75823
+ "dryRun": false,
75824
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
75825
+ "inputSchema": {
75826
+ "params": {
75827
+ "type": "object",
75828
+ "required": false,
75829
+ "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.",
75830
+ "properties": [
75831
+ {
75832
+ "name": "filter",
75833
+ "type": "FilterCondition[]",
75834
+ "optional": true
75835
+ },
75836
+ {
75837
+ "name": "limit",
75838
+ "type": "number",
75839
+ "optional": true,
75840
+ "default": 500
75841
+ },
75842
+ {
75843
+ "name": "latest",
75844
+ "type": "number",
75845
+ "optional": true
75846
+ },
75847
+ {
75848
+ "name": "noteChars",
75849
+ "type": "number",
75850
+ "optional": true
75851
+ },
75852
+ {
75853
+ "name": "includeFields",
75854
+ "type": "string[]",
75855
+ "optional": true
75856
+ },
75857
+ {
75858
+ "name": "fieldCheck",
75859
+ "type": "boolean",
75860
+ "optional": true,
75861
+ "default": true
75862
+ },
75863
+ {
75864
+ "name": "names",
75865
+ "type": "boolean",
75866
+ "optional": true
75867
+ },
75868
+ {
75869
+ "name": "via",
75870
+ "type": "\"post\" | \"get\"",
75871
+ "optional": true
75872
+ },
75873
+ {
75874
+ "name": "acknowledgeUnscoped",
75875
+ "type": "boolean",
75876
+ "optional": true
75877
+ },
75878
+ {
75879
+ "name": "walk",
75880
+ "type": "object",
75881
+ "optional": true
75882
+ }
75883
+ ]
75884
+ }
75885
+ },
75886
+ "inputSchemaStrict": true,
75887
+ "outputSchema": {
75888
+ "type": "QueryActionResult[<Model>,<Entity>]",
75889
+ "drops": []
75890
+ },
75891
+ "examples": [
75892
+ "await invoke(client, 'task_notes.query', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }], limit: 25 }])"
75893
+ ],
75894
+ "permissions": "unknown",
75895
+ "pagination": {
75896
+ "mode": "cursor",
75897
+ "vendorDefault": 10,
75898
+ "vendorMax": 500,
75899
+ "pageGuard": 1000,
75900
+ "queryBounded": {
75901
+ "default": 500,
75902
+ "max": 2500
75903
+ }
75904
+ },
75905
+ "resolution": null,
75906
+ "retry": {
75907
+ "preset": "retry-ffb3a9cb"
75908
+ },
75909
+ "errors": {
75910
+ "set": 4
75911
+ },
75912
+ "metadata": {
75913
+ "purpose": "Query TaskNote records with a JSON filter.",
75914
+ "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 taskID 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.",
75915
+ "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).",
75916
+ "related": [],
75917
+ "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.",
75918
+ "untrustedFields": [
75919
+ "description",
75920
+ "title"
75921
+ ]
75922
+ },
75923
+ "compact": null,
75924
+ "status": "tested"
75925
+ },
75926
+ {
75927
+ "id": "task_notes.update",
75928
+ "resource": "task_notes",
75929
+ "udfCapable": false,
75930
+ "operation": "update",
75931
+ "kind": "primitive",
75932
+ "endpoint": "PUT|PATCH /V1.0/Tasks/{parentId}/Notes",
75933
+ "effect": "write",
75934
+ "flags": [
75935
+ "idempotent"
75936
+ ],
75937
+ "dryRun": true,
75938
+ "envelope": "OperationResultModel",
75939
+ "inputSchema": {
75940
+ "parentId": {
75941
+ "type": "string | number",
75942
+ "required": true,
75943
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
75944
+ },
75945
+ "id": {
75946
+ "type": "string | number",
75947
+ "required": true,
75948
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
75949
+ },
75950
+ "data": {
75951
+ "type": "object",
75952
+ "required": true,
75953
+ "description": "The record payload (vendor model fields)."
75954
+ }
75955
+ },
75956
+ "inputSchemaStrict": true,
75957
+ "outputSchema": {
75958
+ "type": "OperationResultModel",
75959
+ "drops": []
75960
+ },
75961
+ "examples": [
75962
+ "await client.taskNotes.update(7, 3, { description: 'Updated progress' }, { dryRun: true })"
75963
+ ],
75964
+ "permissions": "unknown",
75965
+ "pagination": {
75966
+ "mode": "none"
75967
+ },
75968
+ "resolution": null,
75969
+ "retry": {
75970
+ "preset": "retry-85897a3a"
75971
+ },
75972
+ "errors": {
75973
+ "set": 1
75974
+ },
75975
+ "metadata": {
75976
+ "purpose": "Update a task note.",
75977
+ "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). TaskNoteModel has no supported lastModifiedDate stale token; preview reads a fresh record, without promising an atomic vendor precondition. Parent-scoped: parentId + id. Description writes use plain text and can lose existing rich text/images. Parent taskID is the path argument; a supplied taskID must match. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused.",
75978
+ "preferredWhen": "Use when an existing task note needs a supported field change.",
75979
+ "related": [
75980
+ "task_notes.get"
75981
+ ],
75982
+ "untrustedFields": [
75983
+ "description",
75984
+ "title"
75985
+ ]
75986
+ },
75987
+ "compact": null,
75988
+ "status": "tested"
75989
+ },
75990
+ {
75991
+ "id": "task_predecessors.count",
75992
+ "resource": "task_predecessors",
75993
+ "udfCapable": false,
75994
+ "operation": "count",
75995
+ "kind": "primitive",
75996
+ "endpoint": "GET|POST /V1.0/TaskPredecessors/query/count",
75997
+ "effect": "read",
75998
+ "flags": [],
75999
+ "dryRun": false,
76000
+ "envelope": "QueryCountResultModel",
76001
+ "inputSchema": {
76002
+ "params": {
76003
+ "type": "object",
76004
+ "required": false,
76005
+ "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.",
76006
+ "properties": [
76007
+ {
76008
+ "name": "filter",
76009
+ "type": "FilterCondition[]",
76010
+ "optional": true
76011
+ },
76012
+ {
76013
+ "name": "fieldCheck",
76014
+ "type": "boolean",
76015
+ "optional": true
76016
+ }
76017
+ ]
76018
+ }
76019
+ },
76020
+ "inputSchemaStrict": true,
76021
+ "outputSchema": {
76022
+ "type": "QueryCountResultModel",
76023
+ "drops": []
76024
+ },
76025
+ "examples": [
76026
+ "await invoke(client, 'task_predecessors.count', [{ filter: [{ field: 'successorTaskID', op: 'eq', value: 7 }] }])"
76027
+ ],
76028
+ "permissions": "unknown",
76029
+ "pagination": {
76030
+ "mode": "none"
76031
+ },
76032
+ "resolution": null,
76033
+ "retry": {
76034
+ "preset": "retry-ffb3a9cb"
76035
+ },
76036
+ "errors": {
76037
+ "set": 0
76038
+ },
76039
+ "metadata": {
76040
+ "purpose": "Count task predecessor relationships matching a JSON filter.",
76041
+ "usage": "Unwraps queryCount; returns a plain number.",
76042
+ "preferredWhen": null,
76043
+ "related": [
76044
+ "task_predecessors.query"
76045
+ ],
76046
+ "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."
76047
+ },
76048
+ "compact": null,
76049
+ "status": "tested"
76050
+ },
76051
+ {
76052
+ "id": "task_predecessors.create",
76053
+ "resource": "task_predecessors",
76054
+ "udfCapable": false,
76055
+ "operation": "create",
76056
+ "kind": "primitive",
76057
+ "endpoint": "POST /V1.0/Tasks/{parentId}/Predecessors",
76058
+ "effect": "write",
76059
+ "flags": [],
76060
+ "dryRun": true,
76061
+ "envelope": "OperationResultModel",
76062
+ "inputSchema": {
76063
+ "parentId": {
76064
+ "type": "string | number",
76065
+ "required": true,
76066
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
76067
+ },
76068
+ "data": {
76069
+ "type": "object",
76070
+ "required": true,
76071
+ "description": "The record payload (vendor model fields)."
76072
+ }
76073
+ },
76074
+ "inputSchemaStrict": true,
76075
+ "outputSchema": {
76076
+ "type": "OperationResultModel",
76077
+ "drops": []
76078
+ },
76079
+ "examples": [
76080
+ "await client.taskPredecessors.create(7, { predecessorTaskID: 8, successorTaskID: 7, lagDays: 2 }, { dryRun: true })"
76081
+ ],
76082
+ "permissions": "unknown",
76083
+ "pagination": {
76084
+ "mode": "none"
76085
+ },
76086
+ "resolution": null,
76087
+ "retry": {
76088
+ "preset": "retry-c5657094"
76089
+ },
76090
+ "errors": {
76091
+ "set": 1
76092
+ },
76093
+ "metadata": {
76094
+ "purpose": "create task predecessor relationships.",
76095
+ "usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
76096
+ "preferredWhen": null,
76097
+ "related": []
76098
+ },
76099
+ "compact": null,
76100
+ "status": "tested"
76101
+ },
76102
+ {
76103
+ "id": "task_predecessors.delete",
76104
+ "resource": "task_predecessors",
76105
+ "udfCapable": false,
76106
+ "operation": "delete",
76107
+ "kind": "primitive",
76108
+ "endpoint": "DELETE /V1.0/Tasks/{parentId}/Predecessors/{id}",
76109
+ "effect": "destructive",
76110
+ "flags": [
76111
+ "idempotent",
76112
+ "requiresApproval"
76113
+ ],
76114
+ "dryRun": true,
76115
+ "envelope": "OperationResultModel",
76116
+ "inputSchema": {
76117
+ "parentId": {
76118
+ "type": "string | number",
76119
+ "required": true,
76120
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
76121
+ },
76122
+ "id": {
76123
+ "type": "string | number",
76124
+ "required": true,
76125
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
76126
+ }
76127
+ },
76128
+ "inputSchemaStrict": true,
76129
+ "outputSchema": {
76130
+ "type": "OperationResultModel",
76131
+ "drops": []
76132
+ },
76133
+ "examples": [
76134
+ "await invoke(client, 'task_predecessors.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_predecessors.delete' })"
76135
+ ],
76136
+ "permissions": "unknown",
76137
+ "pagination": {
76138
+ "mode": "none"
76139
+ },
76140
+ "resolution": null,
76141
+ "retry": {
76142
+ "preset": "retry-1849870d"
76143
+ },
76144
+ "errors": {
76145
+ "set": 2
76146
+ },
76147
+ "metadata": {
76148
+ "purpose": "Delete one task predecessor relationship.",
76149
+ "usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token. Destructive invocation requires exact operation confirmation. Preview sends no mutation.",
76150
+ "preferredWhen": null,
76151
+ "related": [
76152
+ "task_predecessors.get"
76153
+ ]
76154
+ },
76155
+ "compact": null,
76156
+ "status": "tested"
76157
+ },
76158
+ {
76159
+ "id": "task_predecessors.get",
76160
+ "resource": "task_predecessors",
76161
+ "udfCapable": false,
76162
+ "operation": "get",
76163
+ "kind": "primitive",
76164
+ "endpoint": "GET /V1.0/Tasks/{parentId}/Predecessors/{id}",
76165
+ "effect": "read",
76166
+ "flags": [],
76167
+ "dryRun": false,
76168
+ "envelope": "ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]",
75229
76169
  "inputSchema": {
75230
76170
  "parentId": {
75231
76171
  "type": "string | number",
@@ -82812,7 +83752,7 @@
82812
83752
  "preset": "retry-6980a375"
82813
83753
  },
82814
83754
  "errors": {
82815
- "set": 12
83755
+ "set": 16
82816
83756
  },
82817
83757
  "metadata": {
82818
83758
  "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).",
@@ -83217,7 +84157,7 @@
83217
84157
  "preset": "retry-ffb3a9cb"
83218
84158
  },
83219
84159
  "errors": {
83220
- "set": 13
84160
+ "set": 17
83221
84161
  },
83222
84162
  "metadata": {
83223
84163
  "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.",
@@ -84407,7 +85347,7 @@
84407
85347
  "preset": "retry-ffb3a9cb"
84408
85348
  },
84409
85349
  "errors": {
84410
- "set": 14
85350
+ "set": 18
84411
85351
  },
84412
85352
  "metadata": {
84413
85353
  "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).",
@@ -84766,8 +85706,8 @@
84766
85706
  ]
84767
85707
  },
84768
85708
  "operations": {
84769
- "planHash": "cff16b0b9d022a81a1926ffacb0d01cf5a1e924805447744b62865a3cf9d3779",
84770
- "builtAt": "2026-11-19T01:02:15.553Z",
85709
+ "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
85710
+ "builtAt": "2026-11-19T03:48:00.874Z",
84771
85711
  "records": [
84772
85712
  {
84773
85713
  "id": "operations.aggregate",
@@ -84850,7 +85790,7 @@
84850
85790
  "preset": "retry-ffb3a9cb"
84851
85791
  },
84852
85792
  "errors": {
84853
- "set": 15
85793
+ "set": 19
84854
85794
  },
84855
85795
  "metadata": {
84856
85796
  "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",
@@ -84931,7 +85871,7 @@
84931
85871
  "preset": "retry-ffb3a9cb"
84932
85872
  },
84933
85873
  "errors": {
84934
- "set": 16
85874
+ "set": 20
84935
85875
  },
84936
85876
  "metadata": {
84937
85877
  "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.",
@@ -84997,7 +85937,7 @@
84997
85937
  "preset": "retry-ffb3a9cb"
84998
85938
  },
84999
85939
  "errors": {
85000
- "set": 17
85940
+ "set": 21
85001
85941
  },
85002
85942
  "metadata": {
85003
85943
  "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.",
@@ -85193,7 +86133,7 @@
85193
86133
  "preset": "retry-ffb3a9cb"
85194
86134
  },
85195
86135
  "errors": {
85196
- "set": 18
86136
+ "set": 22
85197
86137
  },
85198
86138
  "metadata": {
85199
86139
  "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.",
@@ -85290,7 +86230,7 @@
85290
86230
  "preset": "retry-ffb3a9cb"
85291
86231
  },
85292
86232
  "errors": {
85293
- "set": 16
86233
+ "set": 20
85294
86234
  },
85295
86235
  "metadata": {
85296
86236
  "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.",
@@ -85407,7 +86347,7 @@
85407
86347
  "preset": "retry-ffb3a9cb"
85408
86348
  },
85409
86349
  "errors": {
85410
- "set": 19
86350
+ "set": 23
85411
86351
  },
85412
86352
  "metadata": {
85413
86353
  "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.",
@@ -85497,7 +86437,7 @@
85497
86437
  "preset": "retry-ffb3a9cb"
85498
86438
  },
85499
86439
  "errors": {
85500
- "set": 16
86440
+ "set": 20
85501
86441
  },
85502
86442
  "metadata": {
85503
86443
  "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.",
@@ -85552,7 +86492,7 @@
85552
86492
  "preset": "retry-ffb3a9cb"
85553
86493
  },
85554
86494
  "errors": {
85555
- "set": 17
86495
+ "set": 21
85556
86496
  },
85557
86497
  "metadata": {
85558
86498
  "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.",
@@ -85964,7 +86904,7 @@
85964
86904
  "preset": "retry-ffb3a9cb"
85965
86905
  },
85966
86906
  "errors": {
85967
- "set": 16
86907
+ "set": 20
85968
86908
  },
85969
86909
  "metadata": {
85970
86910
  "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.",
@@ -86024,7 +86964,7 @@
86024
86964
  "preset": "retry-ffb3a9cb"
86025
86965
  },
86026
86966
  "errors": {
86027
- "set": 20
86967
+ "set": 24
86028
86968
  },
86029
86969
  "metadata": {
86030
86970
  "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.",
@@ -86292,7 +87232,7 @@
86292
87232
  "preset": "retry-ffb3a9cb"
86293
87233
  },
86294
87234
  "errors": {
86295
- "set": 20
87235
+ "set": 24
86296
87236
  },
86297
87237
  "metadata": {
86298
87238
  "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.",
@@ -86383,7 +87323,7 @@
86383
87323
  "preset": "retry-ffb3a9cb"
86384
87324
  },
86385
87325
  "errors": {
86386
- "set": 21
87326
+ "set": 25
86387
87327
  },
86388
87328
  "metadata": {
86389
87329
  "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.",
@@ -86614,6 +87554,68 @@
86614
87554
  "RESPONSE_TOO_LARGE",
86615
87555
  "REDIRECT_BLOCKED"
86616
87556
  ],
87557
+ [
87558
+ "BAD_REQUEST",
87559
+ "CONFIG_ERROR",
87560
+ "NETWORK_ERROR",
87561
+ "UNAUTHORIZED",
87562
+ "RATE_LIMITED",
87563
+ "TIMEOUT",
87564
+ "SERVER_ERROR",
87565
+ "INVALID_RESPONSE",
87566
+ "ABORTED",
87567
+ "RESPONSE_TOO_LARGE",
87568
+ "REDIRECT_BLOCKED",
87569
+ "FORBIDDEN"
87570
+ ],
87571
+ [
87572
+ "BAD_REQUEST",
87573
+ "CONFIG_ERROR",
87574
+ "NETWORK_ERROR",
87575
+ "UNAUTHORIZED",
87576
+ "RATE_LIMITED",
87577
+ "VALIDATION_FAILED",
87578
+ "CONFLICT",
87579
+ "STALE_OBJECT",
87580
+ "TIMEOUT",
87581
+ "SERVER_ERROR",
87582
+ "INVALID_RESPONSE",
87583
+ "ABORTED",
87584
+ "RESPONSE_TOO_LARGE",
87585
+ "REDIRECT_BLOCKED",
87586
+ "FORBIDDEN"
87587
+ ],
87588
+ [
87589
+ "BAD_REQUEST",
87590
+ "CONFIG_ERROR",
87591
+ "NETWORK_ERROR",
87592
+ "UNAUTHORIZED",
87593
+ "RATE_LIMITED",
87594
+ "VALIDATION_FAILED",
87595
+ "CONFLICT",
87596
+ "TIMEOUT",
87597
+ "SERVER_ERROR",
87598
+ "INVALID_RESPONSE",
87599
+ "ABORTED",
87600
+ "RESPONSE_TOO_LARGE",
87601
+ "REDIRECT_BLOCKED",
87602
+ "FORBIDDEN"
87603
+ ],
87604
+ [
87605
+ "BAD_REQUEST",
87606
+ "CONFIG_ERROR",
87607
+ "NETWORK_ERROR",
87608
+ "UNAUTHORIZED",
87609
+ "RATE_LIMITED",
87610
+ "TIMEOUT",
87611
+ "SERVER_ERROR",
87612
+ "INVALID_RESPONSE",
87613
+ "ABORTED",
87614
+ "RESPONSE_TOO_LARGE",
87615
+ "REDIRECT_BLOCKED",
87616
+ "SCOPE_REQUIRED",
87617
+ "FORBIDDEN"
87618
+ ],
86617
87619
  [
86618
87620
  "STATUS_UNKNOWN",
86619
87621
  "STATUS_FIELDS_REQUIRED",