node-autotask 0.75.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.
- package/CHANGELOG.md +6 -0
- package/MCP_TOOL_CATALOG.json +137 -9
- package/README.md +1 -1
- package/capabilities.json +483 -7
- package/dist/capabilities-data.js +482 -6
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-MCAGTC6R.js → chunk-3SFIKG2R.js} +189 -17
- package/dist/{chunk-YGJCTU7F.cjs → chunk-55BQEFBO.cjs} +31 -30
- package/dist/{chunk-VMFQ53HQ.cjs → chunk-C4S3EKIK.cjs} +3 -3
- package/dist/{chunk-OFYXDB5G.js → chunk-ECSE6B3U.js} +3 -3
- package/dist/{chunk-JEARDPBL.js → chunk-S7QPD6TR.js} +2 -2
- package/dist/{chunk-OTDNHBJJ.js → chunk-UFK7JYYC.js} +3 -2
- package/dist/{chunk-54CRUNXF.cjs → chunk-Y4BH5N6R.cjs} +194 -22
- package/dist/{chunk-52YS7NCR.cjs → chunk-YRTOAPWD.cjs} +199 -199
- package/dist/{index-BEuTtkQE.d.cts → index-BbAzrm2i.d.cts} +46 -1
- package/dist/{index-BEuTtkQE.d.ts → index-BbAzrm2i.d.ts} +46 -1
- package/dist/{index-CNuQgQ_Z.d.ts → index-CY7exGOe.d.ts} +3 -2
- package/dist/{index-BAu5alhB.d.cts → index-MY7qYY5d.d.cts} +3 -2
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +4 -4
- package/dist/operations/index.d.ts +4 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +3 -2
- package/package.json +1 -1
|
@@ -410,8 +410,8 @@ const CAPABILITY_DATA = {
|
|
|
410
410
|
],
|
|
411
411
|
"groups": {
|
|
412
412
|
"B": {
|
|
413
|
-
"planHash": "
|
|
414
|
-
"builtAt": "2026-11-
|
|
413
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
414
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
415
415
|
"records": [
|
|
416
416
|
{
|
|
417
417
|
"id": "appointments.count",
|
|
@@ -43326,8 +43326,8 @@ const CAPABILITY_DATA = {
|
|
|
43326
43326
|
]
|
|
43327
43327
|
},
|
|
43328
43328
|
"A": {
|
|
43329
|
-
"planHash": "
|
|
43330
|
-
"builtAt": "2026-11-
|
|
43329
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
43330
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
43331
43331
|
"records": [
|
|
43332
43332
|
{
|
|
43333
43333
|
"id": "attachment_info.count",
|
|
@@ -75409,6 +75409,482 @@ const CAPABILITY_DATA = {
|
|
|
75409
75409
|
"compact": null,
|
|
75410
75410
|
"status": "tested"
|
|
75411
75411
|
},
|
|
75412
|
+
{
|
|
75413
|
+
"id": "task_note_attachments.count",
|
|
75414
|
+
"resource": "task_note_attachments",
|
|
75415
|
+
"udfCapable": false,
|
|
75416
|
+
"operation": "count",
|
|
75417
|
+
"kind": "primitive",
|
|
75418
|
+
"endpoint": "GET|POST /V1.0/TaskNoteAttachments/query/count",
|
|
75419
|
+
"effect": "read",
|
|
75420
|
+
"flags": [],
|
|
75421
|
+
"dryRun": false,
|
|
75422
|
+
"envelope": "QueryCountResultModel",
|
|
75423
|
+
"inputSchema": {
|
|
75424
|
+
"params": {
|
|
75425
|
+
"type": "object",
|
|
75426
|
+
"required": false,
|
|
75427
|
+
"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.",
|
|
75428
|
+
"properties": [
|
|
75429
|
+
{
|
|
75430
|
+
"name": "filter",
|
|
75431
|
+
"type": "FilterCondition[]",
|
|
75432
|
+
"optional": true
|
|
75433
|
+
},
|
|
75434
|
+
{
|
|
75435
|
+
"name": "fieldCheck",
|
|
75436
|
+
"type": "boolean",
|
|
75437
|
+
"optional": true
|
|
75438
|
+
}
|
|
75439
|
+
]
|
|
75440
|
+
}
|
|
75441
|
+
},
|
|
75442
|
+
"inputSchemaStrict": true,
|
|
75443
|
+
"outputSchema": {
|
|
75444
|
+
"type": "QueryCountResultModel",
|
|
75445
|
+
"drops": []
|
|
75446
|
+
},
|
|
75447
|
+
"examples": [
|
|
75448
|
+
"await invoke(client, 'task_note_attachments.count', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }] }])"
|
|
75449
|
+
],
|
|
75450
|
+
"permissions": "unknown",
|
|
75451
|
+
"pagination": {
|
|
75452
|
+
"mode": "none"
|
|
75453
|
+
},
|
|
75454
|
+
"resolution": null,
|
|
75455
|
+
"retry": {
|
|
75456
|
+
"preset": "retry-ffb3a9cb"
|
|
75457
|
+
},
|
|
75458
|
+
"errors": {
|
|
75459
|
+
"set": 0
|
|
75460
|
+
},
|
|
75461
|
+
"metadata": {
|
|
75462
|
+
"purpose": "Count task note attachment records matching a JSON filter. Use taskNoteID for note scope.",
|
|
75463
|
+
"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.",
|
|
75464
|
+
"preferredWhen": null,
|
|
75465
|
+
"related": [
|
|
75466
|
+
"task_note_attachments.query"
|
|
75467
|
+
],
|
|
75468
|
+
"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.",
|
|
75469
|
+
"untrustedFields": [
|
|
75470
|
+
"title"
|
|
75471
|
+
]
|
|
75472
|
+
},
|
|
75473
|
+
"compact": null,
|
|
75474
|
+
"status": "tested"
|
|
75475
|
+
},
|
|
75476
|
+
{
|
|
75477
|
+
"id": "task_note_attachments.create",
|
|
75478
|
+
"resource": "task_note_attachments",
|
|
75479
|
+
"udfCapable": false,
|
|
75480
|
+
"operation": "create",
|
|
75481
|
+
"kind": "primitive",
|
|
75482
|
+
"endpoint": "POST /V1.0/TaskNotes/{parentId}/Attachments",
|
|
75483
|
+
"effect": "write",
|
|
75484
|
+
"flags": [],
|
|
75485
|
+
"dryRun": true,
|
|
75486
|
+
"envelope": "OperationResultModel",
|
|
75487
|
+
"inputSchema": {
|
|
75488
|
+
"parentId": {
|
|
75489
|
+
"type": "string | number",
|
|
75490
|
+
"required": true,
|
|
75491
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75492
|
+
},
|
|
75493
|
+
"data": {
|
|
75494
|
+
"type": "object",
|
|
75495
|
+
"required": true,
|
|
75496
|
+
"description": "The record payload (vendor model fields)."
|
|
75497
|
+
}
|
|
75498
|
+
},
|
|
75499
|
+
"inputSchemaStrict": true,
|
|
75500
|
+
"outputSchema": {
|
|
75501
|
+
"type": "OperationResultModel",
|
|
75502
|
+
"drops": []
|
|
75503
|
+
},
|
|
75504
|
+
"examples": [
|
|
75505
|
+
"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 });"
|
|
75506
|
+
],
|
|
75507
|
+
"permissions": "unknown",
|
|
75508
|
+
"pagination": {
|
|
75509
|
+
"mode": "none"
|
|
75510
|
+
},
|
|
75511
|
+
"resolution": null,
|
|
75512
|
+
"retry": {
|
|
75513
|
+
"preset": "retry-c5657094"
|
|
75514
|
+
},
|
|
75515
|
+
"errors": {
|
|
75516
|
+
"set": 1
|
|
75517
|
+
},
|
|
75518
|
+
"metadata": {
|
|
75519
|
+
"purpose": "Create a file attachment under a task note.",
|
|
75520
|
+
"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.",
|
|
75521
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
75522
|
+
"related": [
|
|
75523
|
+
"task_note_attachments.get"
|
|
75524
|
+
],
|
|
75525
|
+
"argNotes": {
|
|
75526
|
+
"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."
|
|
75527
|
+
},
|
|
75528
|
+
"untrustedFields": [
|
|
75529
|
+
"title"
|
|
75530
|
+
],
|
|
75531
|
+
"createRequirements": {
|
|
75532
|
+
"requires": {
|
|
75533
|
+
"allOf": [
|
|
75534
|
+
"attachmentType",
|
|
75535
|
+
"fullPath",
|
|
75536
|
+
"title",
|
|
75537
|
+
"publish",
|
|
75538
|
+
"data"
|
|
75539
|
+
]
|
|
75540
|
+
},
|
|
75541
|
+
"requiresByValue": [
|
|
75542
|
+
{
|
|
75543
|
+
"field": "attachmentType",
|
|
75544
|
+
"value": "FILE_ATTACHMENT",
|
|
75545
|
+
"requires": {
|
|
75546
|
+
"allOf": [
|
|
75547
|
+
"data"
|
|
75548
|
+
]
|
|
75549
|
+
}
|
|
75550
|
+
}
|
|
75551
|
+
]
|
|
75552
|
+
}
|
|
75553
|
+
},
|
|
75554
|
+
"compact": null,
|
|
75555
|
+
"status": "tested"
|
|
75556
|
+
},
|
|
75557
|
+
{
|
|
75558
|
+
"id": "task_note_attachments.delete",
|
|
75559
|
+
"resource": "task_note_attachments",
|
|
75560
|
+
"udfCapable": false,
|
|
75561
|
+
"operation": "delete",
|
|
75562
|
+
"kind": "primitive",
|
|
75563
|
+
"endpoint": "DELETE /V1.0/TaskNotes/{parentId}/Attachments/{id}",
|
|
75564
|
+
"effect": "destructive",
|
|
75565
|
+
"flags": [
|
|
75566
|
+
"idempotent",
|
|
75567
|
+
"requiresApproval"
|
|
75568
|
+
],
|
|
75569
|
+
"dryRun": true,
|
|
75570
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75571
|
+
"inputSchema": {
|
|
75572
|
+
"parentId": {
|
|
75573
|
+
"type": "string | number",
|
|
75574
|
+
"required": true,
|
|
75575
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75576
|
+
},
|
|
75577
|
+
"id": {
|
|
75578
|
+
"type": "string | number",
|
|
75579
|
+
"required": true,
|
|
75580
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75581
|
+
}
|
|
75582
|
+
},
|
|
75583
|
+
"inputSchemaStrict": true,
|
|
75584
|
+
"outputSchema": {
|
|
75585
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75586
|
+
"drops": []
|
|
75587
|
+
},
|
|
75588
|
+
"examples": [
|
|
75589
|
+
"await invoke(client, 'task_note_attachments.delete', [7, 3], { confirm: 'task_note_attachments.delete' })"
|
|
75590
|
+
],
|
|
75591
|
+
"permissions": "unknown",
|
|
75592
|
+
"pagination": {
|
|
75593
|
+
"mode": "none"
|
|
75594
|
+
},
|
|
75595
|
+
"resolution": null,
|
|
75596
|
+
"retry": {
|
|
75597
|
+
"preset": "retry-1849870d"
|
|
75598
|
+
},
|
|
75599
|
+
"errors": {
|
|
75600
|
+
"set": 2
|
|
75601
|
+
},
|
|
75602
|
+
"metadata": {
|
|
75603
|
+
"purpose": "Delete an attachment under a task note.",
|
|
75604
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
75605
|
+
"preferredWhen": null,
|
|
75606
|
+
"related": [
|
|
75607
|
+
"task_note_attachments.get"
|
|
75608
|
+
],
|
|
75609
|
+
"untrustedFields": [
|
|
75610
|
+
"title"
|
|
75611
|
+
]
|
|
75612
|
+
},
|
|
75613
|
+
"compact": null,
|
|
75614
|
+
"status": "tested"
|
|
75615
|
+
},
|
|
75616
|
+
{
|
|
75617
|
+
"id": "task_note_attachments.get",
|
|
75618
|
+
"resource": "task_note_attachments",
|
|
75619
|
+
"udfCapable": false,
|
|
75620
|
+
"operation": "get",
|
|
75621
|
+
"kind": "primitive",
|
|
75622
|
+
"endpoint": "GET /V1.0/TaskNotes/{parentId}/Attachments/{id}",
|
|
75623
|
+
"effect": "read",
|
|
75624
|
+
"flags": [],
|
|
75625
|
+
"dryRun": false,
|
|
75626
|
+
"envelope": "TaskNoteAttachmentModel",
|
|
75627
|
+
"inputSchema": {
|
|
75628
|
+
"parentId": {
|
|
75629
|
+
"type": "string | number",
|
|
75630
|
+
"required": true,
|
|
75631
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75632
|
+
},
|
|
75633
|
+
"id": {
|
|
75634
|
+
"type": "string | number",
|
|
75635
|
+
"required": true,
|
|
75636
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75637
|
+
},
|
|
75638
|
+
"opts": {
|
|
75639
|
+
"type": "object",
|
|
75640
|
+
"required": false,
|
|
75641
|
+
"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.",
|
|
75642
|
+
"properties": [
|
|
75643
|
+
{
|
|
75644
|
+
"name": "fresh",
|
|
75645
|
+
"type": "boolean",
|
|
75646
|
+
"optional": true
|
|
75647
|
+
}
|
|
75648
|
+
]
|
|
75649
|
+
}
|
|
75650
|
+
},
|
|
75651
|
+
"inputSchemaStrict": true,
|
|
75652
|
+
"outputSchema": {
|
|
75653
|
+
"type": "TaskNoteAttachmentModel",
|
|
75654
|
+
"drops": []
|
|
75655
|
+
},
|
|
75656
|
+
"examples": [
|
|
75657
|
+
"await client.taskNoteAttachments.get(7, 3)"
|
|
75658
|
+
],
|
|
75659
|
+
"permissions": "unknown",
|
|
75660
|
+
"pagination": {
|
|
75661
|
+
"mode": "none"
|
|
75662
|
+
},
|
|
75663
|
+
"resolution": null,
|
|
75664
|
+
"retry": {
|
|
75665
|
+
"preset": "retry-ffb3a9cb"
|
|
75666
|
+
},
|
|
75667
|
+
"errors": {
|
|
75668
|
+
"set": 3
|
|
75669
|
+
},
|
|
75670
|
+
"metadata": {
|
|
75671
|
+
"purpose": "Get one TaskNoteAttachment by id.",
|
|
75672
|
+
"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.",
|
|
75673
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
75674
|
+
"related": [
|
|
75675
|
+
"task_note_attachments.query"
|
|
75676
|
+
],
|
|
75677
|
+
"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.",
|
|
75678
|
+
"untrustedFields": [
|
|
75679
|
+
"title"
|
|
75680
|
+
]
|
|
75681
|
+
},
|
|
75682
|
+
"compact": null,
|
|
75683
|
+
"status": "tested"
|
|
75684
|
+
},
|
|
75685
|
+
{
|
|
75686
|
+
"id": "task_note_attachments.getEntityInfo",
|
|
75687
|
+
"resource": "task_note_attachments",
|
|
75688
|
+
"udfCapable": false,
|
|
75689
|
+
"operation": "getEntityInfo",
|
|
75690
|
+
"kind": "primitive",
|
|
75691
|
+
"endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation",
|
|
75692
|
+
"effect": "read",
|
|
75693
|
+
"flags": [],
|
|
75694
|
+
"dryRun": false,
|
|
75695
|
+
"envelope": "EntityInformationResultModel",
|
|
75696
|
+
"inputSchema": {},
|
|
75697
|
+
"inputSchemaStrict": true,
|
|
75698
|
+
"outputSchema": {
|
|
75699
|
+
"type": "EntityInformationResultModel",
|
|
75700
|
+
"drops": []
|
|
75701
|
+
},
|
|
75702
|
+
"examples": [
|
|
75703
|
+
"await client.taskNoteAttachments.getEntityInfo()"
|
|
75704
|
+
],
|
|
75705
|
+
"permissions": "unknown",
|
|
75706
|
+
"pagination": {
|
|
75707
|
+
"mode": "none"
|
|
75708
|
+
},
|
|
75709
|
+
"resolution": null,
|
|
75710
|
+
"retry": {
|
|
75711
|
+
"preset": "retry-ffb3a9cb"
|
|
75712
|
+
},
|
|
75713
|
+
"errors": {
|
|
75714
|
+
"set": 0
|
|
75715
|
+
},
|
|
75716
|
+
"metadata": {
|
|
75717
|
+
"purpose": "Get the TaskNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
75718
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
75719
|
+
"preferredWhen": null,
|
|
75720
|
+
"related": [
|
|
75721
|
+
"task_note_attachments.getFieldInfo"
|
|
75722
|
+
],
|
|
75723
|
+
"untrustedFields": [
|
|
75724
|
+
"title"
|
|
75725
|
+
]
|
|
75726
|
+
},
|
|
75727
|
+
"compact": null,
|
|
75728
|
+
"status": "tested"
|
|
75729
|
+
},
|
|
75730
|
+
{
|
|
75731
|
+
"id": "task_note_attachments.getFieldInfo",
|
|
75732
|
+
"resource": "task_note_attachments",
|
|
75733
|
+
"udfCapable": false,
|
|
75734
|
+
"operation": "getFieldInfo",
|
|
75735
|
+
"kind": "primitive",
|
|
75736
|
+
"endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation/fields",
|
|
75737
|
+
"effect": "read",
|
|
75738
|
+
"flags": [],
|
|
75739
|
+
"dryRun": false,
|
|
75740
|
+
"envelope": "FieldInformationResultModel",
|
|
75741
|
+
"inputSchema": {},
|
|
75742
|
+
"inputSchemaStrict": true,
|
|
75743
|
+
"outputSchema": {
|
|
75744
|
+
"type": "FieldInformationResultModel",
|
|
75745
|
+
"drops": []
|
|
75746
|
+
},
|
|
75747
|
+
"examples": [
|
|
75748
|
+
"await client.taskNoteAttachments.getFieldInfo()"
|
|
75749
|
+
],
|
|
75750
|
+
"permissions": "unknown",
|
|
75751
|
+
"pagination": {
|
|
75752
|
+
"mode": "none"
|
|
75753
|
+
},
|
|
75754
|
+
"resolution": null,
|
|
75755
|
+
"retry": {
|
|
75756
|
+
"preset": "retry-ffb3a9cb"
|
|
75757
|
+
},
|
|
75758
|
+
"errors": {
|
|
75759
|
+
"set": 0
|
|
75760
|
+
},
|
|
75761
|
+
"metadata": {
|
|
75762
|
+
"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).",
|
|
75763
|
+
"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.",
|
|
75764
|
+
"preferredWhen": null,
|
|
75765
|
+
"related": [
|
|
75766
|
+
"task_note_attachments.getEntityInfo"
|
|
75767
|
+
],
|
|
75768
|
+
"untrustedFields": [
|
|
75769
|
+
"title"
|
|
75770
|
+
]
|
|
75771
|
+
},
|
|
75772
|
+
"compact": null,
|
|
75773
|
+
"status": "tested"
|
|
75774
|
+
},
|
|
75775
|
+
{
|
|
75776
|
+
"id": "task_note_attachments.query",
|
|
75777
|
+
"resource": "task_note_attachments",
|
|
75778
|
+
"udfCapable": false,
|
|
75779
|
+
"operation": "query",
|
|
75780
|
+
"kind": "primitive",
|
|
75781
|
+
"endpoint": "GET|POST /V1.0/TaskNoteAttachments/query",
|
|
75782
|
+
"effect": "read",
|
|
75783
|
+
"flags": [],
|
|
75784
|
+
"dryRun": false,
|
|
75785
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
75786
|
+
"inputSchema": {
|
|
75787
|
+
"params": {
|
|
75788
|
+
"type": "object",
|
|
75789
|
+
"required": false,
|
|
75790
|
+
"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.",
|
|
75791
|
+
"properties": [
|
|
75792
|
+
{
|
|
75793
|
+
"name": "filter",
|
|
75794
|
+
"type": "FilterCondition[]",
|
|
75795
|
+
"optional": true
|
|
75796
|
+
},
|
|
75797
|
+
{
|
|
75798
|
+
"name": "limit",
|
|
75799
|
+
"type": "number",
|
|
75800
|
+
"optional": true,
|
|
75801
|
+
"default": 500
|
|
75802
|
+
},
|
|
75803
|
+
{
|
|
75804
|
+
"name": "latest",
|
|
75805
|
+
"type": "number",
|
|
75806
|
+
"optional": true
|
|
75807
|
+
},
|
|
75808
|
+
{
|
|
75809
|
+
"name": "noteChars",
|
|
75810
|
+
"type": "number",
|
|
75811
|
+
"optional": true
|
|
75812
|
+
},
|
|
75813
|
+
{
|
|
75814
|
+
"name": "includeFields",
|
|
75815
|
+
"type": "string[]",
|
|
75816
|
+
"optional": true
|
|
75817
|
+
},
|
|
75818
|
+
{
|
|
75819
|
+
"name": "fieldCheck",
|
|
75820
|
+
"type": "boolean",
|
|
75821
|
+
"optional": true,
|
|
75822
|
+
"default": true
|
|
75823
|
+
},
|
|
75824
|
+
{
|
|
75825
|
+
"name": "names",
|
|
75826
|
+
"type": "boolean",
|
|
75827
|
+
"optional": true
|
|
75828
|
+
},
|
|
75829
|
+
{
|
|
75830
|
+
"name": "via",
|
|
75831
|
+
"type": "\"post\" | \"get\"",
|
|
75832
|
+
"optional": true
|
|
75833
|
+
},
|
|
75834
|
+
{
|
|
75835
|
+
"name": "acknowledgeUnscoped",
|
|
75836
|
+
"type": "boolean",
|
|
75837
|
+
"optional": true
|
|
75838
|
+
},
|
|
75839
|
+
{
|
|
75840
|
+
"name": "walk",
|
|
75841
|
+
"type": "object",
|
|
75842
|
+
"optional": true
|
|
75843
|
+
}
|
|
75844
|
+
]
|
|
75845
|
+
}
|
|
75846
|
+
},
|
|
75847
|
+
"inputSchemaStrict": true,
|
|
75848
|
+
"outputSchema": {
|
|
75849
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
75850
|
+
"drops": []
|
|
75851
|
+
},
|
|
75852
|
+
"examples": [
|
|
75853
|
+
"await invoke(client, 'task_note_attachments.query', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
75854
|
+
],
|
|
75855
|
+
"permissions": "unknown",
|
|
75856
|
+
"pagination": {
|
|
75857
|
+
"mode": "cursor",
|
|
75858
|
+
"vendorDefault": 10,
|
|
75859
|
+
"vendorMax": 500,
|
|
75860
|
+
"pageGuard": 1000,
|
|
75861
|
+
"queryBounded": {
|
|
75862
|
+
"default": 500,
|
|
75863
|
+
"max": 2500
|
|
75864
|
+
}
|
|
75865
|
+
},
|
|
75866
|
+
"resolution": null,
|
|
75867
|
+
"retry": {
|
|
75868
|
+
"preset": "retry-ffb3a9cb"
|
|
75869
|
+
},
|
|
75870
|
+
"errors": {
|
|
75871
|
+
"set": 4
|
|
75872
|
+
},
|
|
75873
|
+
"metadata": {
|
|
75874
|
+
"purpose": "Query TaskNoteAttachment records with a JSON filter.",
|
|
75875
|
+
"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.",
|
|
75876
|
+
"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).",
|
|
75877
|
+
"related": [
|
|
75878
|
+
"task_note_attachments.get"
|
|
75879
|
+
],
|
|
75880
|
+
"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.",
|
|
75881
|
+
"untrustedFields": [
|
|
75882
|
+
"title"
|
|
75883
|
+
]
|
|
75884
|
+
},
|
|
75885
|
+
"compact": null,
|
|
75886
|
+
"status": "tested"
|
|
75887
|
+
},
|
|
75412
75888
|
{
|
|
75413
75889
|
"id": "task_notes.count",
|
|
75414
75890
|
"resource": "task_notes",
|
|
@@ -85638,8 +86114,8 @@ const CAPABILITY_DATA = {
|
|
|
85638
86114
|
]
|
|
85639
86115
|
},
|
|
85640
86116
|
"operations": {
|
|
85641
|
-
"planHash": "
|
|
85642
|
-
"builtAt": "2026-11-
|
|
86117
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
86118
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
85643
86119
|
"records": [
|
|
85644
86120
|
{
|
|
85645
86121
|
"id": "operations.aggregate",
|
package/dist/capabilities.cjs
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkC4S3EKIK_cjs = require('./chunk-C4S3EKIK.cjs');
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
Object.defineProperty(exports, "CAPABILITY_PLAN_HASHES", {
|
|
8
8
|
enumerable: true,
|
|
9
|
-
get: function () { return
|
|
9
|
+
get: function () { return chunkC4S3EKIK_cjs.CAPABILITY_PLAN_HASHES; }
|
|
10
10
|
});
|
|
11
11
|
Object.defineProperty(exports, "loadCapabilities", {
|
|
12
12
|
enumerable: true,
|
|
13
|
-
get: function () { return
|
|
13
|
+
get: function () { return chunkC4S3EKIK_cjs.loadCapabilities; }
|
|
14
14
|
});
|
|
15
15
|
Object.defineProperty(exports, "loadCapabilityRecords", {
|
|
16
16
|
enumerable: true,
|
|
17
|
-
get: function () { return
|
|
17
|
+
get: function () { return chunkC4S3EKIK_cjs.loadCapabilityRecords; }
|
|
18
18
|
});
|
package/dist/capabilities.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export { CAPABILITY_PLAN_HASHES, loadCapabilities, loadCapabilityRecords } from './chunk-
|
|
1
|
+
export { CAPABILITY_PLAN_HASHES, loadCapabilities, loadCapabilityRecords } from './chunk-ECSE6B3U.js';
|