node-autotask 0.64.0 → 0.65.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 +25 -0
- package/MCP_TOOL_CATALOG.json +4 -4
- package/capabilities.json +42 -42
- package/dist/capabilities-data.js +41 -41
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-NWQVMOP5.js → chunk-C73NILBZ.js} +2 -2
- package/dist/{chunk-MIKVE6VJ.cjs → chunk-M63TK4ZH.cjs} +174 -174
- package/dist/{chunk-SVCTQVTV.js → chunk-MXLE2F5G.js} +2 -2
- package/dist/{chunk-C3OLJGY5.js → chunk-N4EO3KAY.js} +3 -3
- package/dist/{chunk-AGGOZD2J.cjs → chunk-NTHEFYA7.cjs} +34 -15
- package/dist/{chunk-7DC524X3.cjs → chunk-UHV7SAX6.cjs} +31 -31
- package/dist/{chunk-BQNC4RYG.js → chunk-ULI4UUB3.js} +29 -10
- package/dist/{chunk-ENRW25IT.cjs → chunk-WKR5IJEC.cjs} +3 -3
- package/dist/{index-B7bZQ34O.d.cts → index-CRVQBajX.d.cts} +1 -1
- package/dist/{index-RkTNsoOz.d.ts → index-vcFKvZqm.d.ts} +1 -1
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +50 -50
- package/dist/operations/index.d.cts +2 -2
- package/dist/operations/index.d.ts +2 -2
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +8 -8
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +1 -1
- package/dist/resources/index.d.ts +1 -1
- package/dist/resources/index.js +3 -3
- package/docs/VENDOR-QUIRKS.md +14 -3
- package/package.json +4 -4
|
@@ -348,8 +348,8 @@ const CAPABILITY_DATA = {
|
|
|
348
348
|
],
|
|
349
349
|
"groups": {
|
|
350
350
|
"B": {
|
|
351
|
-
"planHash": "
|
|
352
|
-
"builtAt": "2026-11-
|
|
351
|
+
"planHash": "546e9de78d62f2c30190c1bb82f89be73f9cc0a75d633d771956566c78f4efeb",
|
|
352
|
+
"builtAt": "2026-11-17T02:57:12.895Z",
|
|
353
353
|
"records": [
|
|
354
354
|
{
|
|
355
355
|
"id": "appointments.count",
|
|
@@ -1062,7 +1062,7 @@ const CAPABILITY_DATA = {
|
|
|
1062
1062
|
},
|
|
1063
1063
|
"metadata": {
|
|
1064
1064
|
"purpose": "Count billing code records matching a JSON filter.",
|
|
1065
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
1065
|
+
"usage": "Unwraps queryCount; returns a plain number. Vendor quirk: the unfiltered count/query surface is blind — query with `useType` (1 = general, 3 = internal) + `isActive` filters. A raw caller must pass those filters (the allocation-code-aware createForResource node op was cut).",
|
|
1066
1066
|
"preferredWhen": null,
|
|
1067
1067
|
"related": [
|
|
1068
1068
|
"billing_codes.query"
|
|
@@ -1386,7 +1386,7 @@ const CAPABILITY_DATA = {
|
|
|
1386
1386
|
},
|
|
1387
1387
|
"metadata": {
|
|
1388
1388
|
"purpose": "Query BillingCode records with a JSON filter.",
|
|
1389
|
-
"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).
|
|
1389
|
+
"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). Vendor quirk: the unfiltered count/query surface is blind — query with `useType` (1 = general, 3 = internal) + `isActive` filters. A raw caller must pass those filters (the allocation-code-aware createForResource node op was cut). 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.",
|
|
1390
1390
|
"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).",
|
|
1391
1391
|
"related": [
|
|
1392
1392
|
"billing_codes.resolve"
|
|
@@ -39372,7 +39372,7 @@ const CAPABILITY_DATA = {
|
|
|
39372
39372
|
},
|
|
39373
39373
|
"examples": [
|
|
39374
39374
|
"await client.timeEntries.create({ resourceID: 2001, dateWorked: '2026-10-03' }, { dryRun: true })",
|
|
39375
|
-
"
|
|
39375
|
+
"the low-level escape hatch — posts exactly the given body (resourceID is the only vendor-required field) and lets the vendor linkage/allocation-code gates surface verbatim Resolve the allocation code yourself (billing_codes query with the family + active filter — the unfiltered surface is blind) or pass a linkage pin (ticketID/taskID/roleID)."
|
|
39376
39376
|
],
|
|
39377
39377
|
"permissions": "unknown",
|
|
39378
39378
|
"pagination": {
|
|
@@ -39387,7 +39387,7 @@ const CAPABILITY_DATA = {
|
|
|
39387
39387
|
},
|
|
39388
39388
|
"metadata": {
|
|
39389
39389
|
"purpose": "Create a time entry.",
|
|
39390
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.",
|
|
39390
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. On internal-organisation tickets (companyID 0) showOnInvoice must be false — true is refused by the vendor (500 \"This time entry cannot be shown on an Invoice because it is for your internal organization.\"); the vendor stores isNonBillable true on internal-organisation entries (a create that sent false read back true)",
|
|
39391
39391
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
39392
39392
|
"related": [
|
|
39393
39393
|
"time_entries.update"
|
|
@@ -39540,7 +39540,7 @@ const CAPABILITY_DATA = {
|
|
|
39540
39540
|
"set": 8
|
|
39541
39541
|
},
|
|
39542
39542
|
"metadata": {
|
|
39543
|
-
"purpose": "The ONE posted-state read: a bounded read over the inclusive dateWorked window [from, to] (UTC 'YYYY-MM-DD' days) with the posted/unposted split derived from the billing_items.timeEntryID join — never a postedDate read (
|
|
39543
|
+
"purpose": "The ONE posted-state read: a bounded read over the inclusive dateWorked window [from, to] (UTC 'YYYY-MM-DD' days) with the posted/unposted split derived from the billing_items.timeEntryID join — never a postedDate read (the TimeEntry entity has no postedDate; postedDate exist|notExist 500s). Approval is NOT consulted (the vendor never populates billingApprovalDateTime yet bills those entries). The no-window form is gone: read with no dateWorked filter goes through time_entries.query.",
|
|
39544
39544
|
"usage": "dateWorkedWindow(from, to, opts?): from/to are required inclusive 'YYYY-MM-DD' UTC days (impossible calendar days like 2026-02-31 and from-after-to are refused pre-request, zero wire). opts.state: 'posted' | 'unposted' — client-side narrowing AFTER the join (replaces the old posted boolean and the getPosted/getUnposted state modes); omitted = both. opts.limit 1-500 (default 500 = the hard cap); opts.ticketID / opts.resourceID eq narrowings sent server-side. Returns { items, postedCount, unpostedCount, window { from, to } (wire bounds, second precision), nextCursor, unconfirmed, truncated }: postedCount/unpostedCount split EVERY entry read (before state narrowing) while items is narrowed, so counts cover the returned rows ONLY (at most limit); truncated is true when the entry read has a live next-page cursor or a join page was truncated; unconfirmed entries sit in neither count nor items. Paging: opts.cursor (a previous nextCursor; a cursor whose path is not the TimeEntries continuation is refused RESPONSE_REJECTED; over 2048 chars refused). opts.countOnly: true (with opts.maxVendorCalls integer 1-200, default 30) returns the whole-window totals { window, total, postedCount, unpostedCount, vendorCalls, estimate, budget } instead of rows: one count call sizes the window, every entry page is read ids-only and joined at 250 ids per join, then the window is counted again — over budget BUDGET_EXCEEDED (the estimate named), a truncated join RESOLUTION_TRUNCATED, a distinct-id total equal to neither count INVALID_RESPONSE; no short total is ever returned. 429 and vendor faults propagate typed. Wire: one bounded POST /V1.0/TimeEntries/query (MaxRecords, dateWorked gte/lte + the eq narrowings) plus at most 2 BillingItems join queries (250 ids each). For a window with more rows than the cap, page with cursor or reconcile through time_entries.query with the same dateWorked filter (its 2500-row walk cap).",
|
|
39545
39545
|
"preferredWhen": null,
|
|
39546
39546
|
"related": [],
|
|
@@ -40544,7 +40544,7 @@ const CAPABILITY_DATA = {
|
|
|
40544
40544
|
},
|
|
40545
40545
|
"metadata": {
|
|
40546
40546
|
"purpose": "Update a time entry.",
|
|
40547
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. ticketID does NOT persist on update: the vendor returns success but keeps the old ticketID (probed live
|
|
40547
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. ticketID does NOT persist on update: the vendor returns success but keeps the old ticketID (probed live, 2026-10-21). To re-parent use time_entries.moveToTicket (create, verify, delete). The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET — also the stale-object guard's read) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
40548
40548
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change. Not for ticketID: the vendor ignores it on update; use time_entries.moveToTicket.",
|
|
40549
40549
|
"related": [
|
|
40550
40550
|
"time_entries.get"
|
|
@@ -43071,8 +43071,8 @@ const CAPABILITY_DATA = {
|
|
|
43071
43071
|
]
|
|
43072
43072
|
},
|
|
43073
43073
|
"A": {
|
|
43074
|
-
"planHash": "
|
|
43075
|
-
"builtAt": "2026-11-
|
|
43074
|
+
"planHash": "546e9de78d62f2c30190c1bb82f89be73f9cc0a75d633d771956566c78f4efeb",
|
|
43075
|
+
"builtAt": "2026-11-17T02:57:12.896Z",
|
|
43076
43076
|
"records": [
|
|
43077
43077
|
{
|
|
43078
43078
|
"id": "companies.count",
|
|
@@ -43125,7 +43125,7 @@ const CAPABILITY_DATA = {
|
|
|
43125
43125
|
},
|
|
43126
43126
|
"metadata": {
|
|
43127
43127
|
"purpose": "Count company records matching a JSON filter.",
|
|
43128
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
43128
|
+
"usage": "Unwraps queryCount; returns a plain number. Vendor quirk: count/query return 0/empty for companies not owned by the caller — verify presence with get(id), not count.",
|
|
43129
43129
|
"preferredWhen": null,
|
|
43130
43130
|
"related": [
|
|
43131
43131
|
"companies.query"
|
|
@@ -43192,7 +43192,7 @@ const CAPABILITY_DATA = {
|
|
|
43192
43192
|
},
|
|
43193
43193
|
"examples": [
|
|
43194
43194
|
"await client.companies.create({ companyName: 'Example', companyType: 1, phone: '1300555001', isActive: true, ownerResourceID: 2001 }, { dryRun: true })",
|
|
43195
|
-
"
|
|
43195
|
+
"validated: created a company with this body (required: companyName, companyType, phone, ownerResourceID — a non-API-only resource). CompanyModel has NO description field (the vendor silently 200s unknown fields); the create auto-creates a vendor \"Primary Address\" location (UI-only cleanup)."
|
|
43196
43196
|
],
|
|
43197
43197
|
"permissions": "unknown",
|
|
43198
43198
|
"pagination": {
|
|
@@ -43337,7 +43337,7 @@ const CAPABILITY_DATA = {
|
|
|
43337
43337
|
},
|
|
43338
43338
|
"examples": [
|
|
43339
43339
|
"await client.companies.fullProfile(1001)",
|
|
43340
|
-
"
|
|
43340
|
+
"validated: a run served 1001 in exactly 6 wire (1 location; openTickets: 3 — data). args: (company id, optional { contactLimit, noteLimit, ticketLimit, projectLimit — default 50 }). openTickets part: open = status NOT in the tenant-resolved closed set (`tickets.statusSemantics`; ids {5} with source 'picklist' today, 'assumed' + a disclosing note when the catalog is unreadable); the part's query is always filtered and the tickets surface is blind UNFILTERED (verified: the filtered query returns data), so an empty answer is a TRUE zero — the typed blind part (blind: true + the blindSurface sentinel) only for a blind class that covers this filtered call. Company missing → NOT_FOUND."
|
|
43341
43341
|
],
|
|
43342
43342
|
"permissions": "unknown",
|
|
43343
43343
|
"pagination": {
|
|
@@ -43352,7 +43352,7 @@ const CAPABILITY_DATA = {
|
|
|
43352
43352
|
},
|
|
43353
43353
|
"metadata": {
|
|
43354
43354
|
"purpose": "Get everything the node knows about one company in a single call: the company record, its locations, contacts and notes, its open tickets, and its projects — every part separately reported with caps.",
|
|
43355
|
-
"usage": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number (default 50), noteLimit?: number (default 50), ticketLimit?: number (default 50), projectLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name/label siblings — the company row (owner / created-by resource names), the openTickets rows (the same closed-scope ticket-field siblings as tickets.fullContext, incl. the ticket picklist labels), the projects rows (lead / creator resource names + the contract name — project picklists stay OUT of the closed label scope) — + the top-level `names` section; the siblings ride the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads: cache hits are free of the budget, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: exactly 6 reads (companies.get + 5 companyID-filtered queries). With names: true, N added name reads (N = the distinct uncached ids, capped by maxNameReads) + at most ONE fieldCatalog labels read (zero wire on a warm fieldCache). The openTickets part: open = status NOT in the resolved closed set — the closed ids come from the tenant's Tickets status picklist via `tickets.statusSemantics` (one cache-aware field-metadata read, zero wire on a warm cache), falling back to id 5 with `source: 'assumed'` and a part `note` that discloses it; the part carries `closedStatus { closedIds, source, note }` and the always-filtered query applies the resolved leaf (a single `not-eq` for one closed id, `notIn` for several); the tickets count/query surface is blind UNFILTERED
|
|
43355
|
+
"usage": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number (default 50), noteLimit?: number (default 50), ticketLimit?: number (default 50), projectLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name/label siblings — the company row (owner / created-by resource names), the openTickets rows (the same closed-scope ticket-field siblings as tickets.fullContext, incl. the ticket picklist labels), the projects rows (lead / creator resource names + the contract name — project picklists stay OUT of the closed label scope) — + the top-level `names` section; the siblings ride the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads: cache hits are free of the budget, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: exactly 6 reads (companies.get + 5 companyID-filtered queries). With names: true, N added name reads (N = the distinct uncached ids, capped by maxNameReads) + at most ONE fieldCatalog labels read (zero wire on a warm fieldCache). The openTickets part: open = status NOT in the resolved closed set — the closed ids come from the tenant's Tickets status picklist via `tickets.statusSemantics` (one cache-aware field-metadata read, zero wire on a warm cache), falling back to id 5 with `source: 'assumed'` and a part `note` that discloses it; the part carries `closedStatus { closedIds, source, note }` and the always-filtered query applies the resolved leaf (a single `not-eq` for one closed id, `notIn` for several); the tickets count/query surface is blind UNFILTERED (verified: the FILTERED query returns data), so this always-filtered part degrades to `blind: true` + the typed `blindSurface` sentinel ONLY when the filter-aware `blindStampFor` predicate stamps this call (post-merge P1) — a filtered empty answer is a TRUE zero (the company has no open tickets), and a non-empty answer is data; the flag clears either way. Company missing → NOT_FOUND.",
|
|
43356
43356
|
"preferredWhen": "The single read for 'what do you know about this company' — replaces 6 raw reads + describes with one call. companies.get alone is just the record.",
|
|
43357
43357
|
"related": [
|
|
43358
43358
|
"companies.get",
|
|
@@ -43968,7 +43968,7 @@ const CAPABILITY_DATA = {
|
|
|
43968
43968
|
},
|
|
43969
43969
|
"metadata": {
|
|
43970
43970
|
"purpose": "Query Company records with a JSON filter.",
|
|
43971
|
-
"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).
|
|
43971
|
+
"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). Vendor quirk: count/query return 0/empty for companies not owned by the caller — verify presence with get(id), not count. 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.",
|
|
43972
43972
|
"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).",
|
|
43973
43973
|
"related": [
|
|
43974
43974
|
"companies.resolve"
|
|
@@ -44482,7 +44482,7 @@ const CAPABILITY_DATA = {
|
|
|
44482
44482
|
},
|
|
44483
44483
|
"metadata": {
|
|
44484
44484
|
"purpose": "One call for a company's unbilled work: its posted billing items (per source), the time behind them (joined through the company's tickets and tasks — time entries carry no companyID), the per-ticket rollup, the unposted anti-join section, ex-tax totals + hours, and the billing-vs-time warnings",
|
|
44485
|
-
"usage": "args[0] is the company id (number); args[1] (optional) is UnbilledWorkOptions { source?: 'posted_uninvoiced' (default — the billing items with no invoiceID (notExist), the uninvoiced mark) | 'invoice' (invoiceID = invoiceId; the invoice record itself is NOT fetched in v1 — the items already carry invoiceID/itemDate/amounts) | 'date_range' (itemDate window — dateFrom + dateTo REQUIRED) | 'tickets' (ticketID in ticketIds; the time-entries part additionally joins those tickets directly), includeParent?: boolean (default true — ONE level only, via company.parentCompanyID; dangling → parent: null, parent parts empty, NOT an error), dateFrom?/dateTo?: string (YYYY-MM-DD — the itemDate window on the billing part in EVERY source, the dateWorked window on the time part; required for date_range), invoiceId?: number | string (required shape for invoice), ticketIds?: (number | string)[] (required non-empty for tickets), includeNotes?: boolean (default false — the note fields EXCLUDED; when true the time part requests summaryNotes and the billing part description, each capped at noteChars with the marker BEFORE the server-side untrusted wrapper), noteChars?: number (default 400, integer >= 1), rollup?: 'ticket' (default — per-ticket rows; the unassigned bucket carries ticketId null) | 'entry' (the capped per-entry list), limit?: number (default 50, clamped 1..500 — the per-part record cap) }. Wire: exactly 6 bounded reads without a parent (company get + tickets + projects + tasks + billing + time queries), 7 with a parent present — zero mutating; includeNotes/noteChars/rollup add ZERO wire (response-side). The join: the company's ticket ids (tickets query, companyID in) + the company's task ids (projects query, companyID in → tasks query, projectID in); the time query is or [taskID in, ticketID in] (the join sets are capped at 300 ids per list — the 8000-char filter cap — with a documented note when truncated); an EMPTY join set skips the time part with status 'skipped' + the honest note (no tasks/tickets to join against is NOT evidence of no time entries). Per part: the capped/hasMore flags + the status 'ok' | 'blind' | 'skipped' (the blind stamp is the filter-aware predicate — a FILTERED empty part is a TRUE zero with the status note, never a sentinel; the pinned
|
|
44485
|
+
"usage": "args[0] is the company id (number); args[1] (optional) is UnbilledWorkOptions { source?: 'posted_uninvoiced' (default — the billing items with no invoiceID (notExist), the uninvoiced mark) | 'invoice' (invoiceID = invoiceId; the invoice record itself is NOT fetched in v1 — the items already carry invoiceID/itemDate/amounts) | 'date_range' (itemDate window — dateFrom + dateTo REQUIRED) | 'tickets' (ticketID in ticketIds; the time-entries part additionally joins those tickets directly), includeParent?: boolean (default true — ONE level only, via company.parentCompanyID; dangling → parent: null, parent parts empty, NOT an error), dateFrom?/dateTo?: string (YYYY-MM-DD — the itemDate window on the billing part in EVERY source, the dateWorked window on the time part; required for date_range), invoiceId?: number | string (required shape for invoice), ticketIds?: (number | string)[] (required non-empty for tickets), includeNotes?: boolean (default false — the note fields EXCLUDED; when true the time part requests summaryNotes and the billing part description, each capped at noteChars with the marker BEFORE the server-side untrusted wrapper), noteChars?: number (default 400, integer >= 1), rollup?: 'ticket' (default — per-ticket rows; the unassigned bucket carries ticketId null) | 'entry' (the capped per-entry list), limit?: number (default 50, clamped 1..500 — the per-part record cap) }. Wire: exactly 6 bounded reads without a parent (company get + tickets + projects + tasks + billing + time queries), 7 with a parent present — zero mutating; includeNotes/noteChars/rollup add ZERO wire (response-side). The join: the company's ticket ids (tickets query, companyID in) + the company's task ids (projects query, companyID in → tasks query, projectID in); the time query is or [taskID in, ticketID in] (the join sets are capped at 300 ids per list — the 8000-char filter cap — with a documented note when truncated); an EMPTY join set skips the time part with status 'skipped' + the honest note (no tasks/tickets to join against is NOT evidence of no time entries). Per part: the capped/hasMore flags + the status 'ok' | 'blind' | 'skipped' (the blind stamp is the filter-aware predicate — a FILTERED empty part is a TRUE zero with the status note, never a sentinel; the pinned unfiltered-blind tickets surface is always queried filtered here). The billing part rides the billing_join column list as its IncludeFields (the join's columns, + id; + description with includeNotes). The client-side folds (zero wire): rollup (billing items by ticketID; time entries by their own ticketID — the vendored TaskModel carries no ticket field, so the entry's own ticketID is the only resolvable ticket link; null → the unassigned bucket), unposted (the fetched entries whose id is in no fetched billing item's timeEntryID), totals { preTax = Σ extendedPrice, hours = Σ hoursWorked, entryCount, totalAmount, taxDollars — surfaced for reconciliation } derived from the SAME folded rows (one source of truth), warnings { noTimeEntry (the billing items whose timeEntryID is empty/0 — capped list + count), hourDelta (the billing items WITH a resolvable time entry where |billed quantity − hoursWorked| > 0 — strict; capped list + count) }. Company missing → NOT_FOUND (zero further wire). Closed opts bag: an unknown key → typed CONFIG_ERROR naming the key + the valid keys (one-round complete problem list, pre-request, zero wire).",
|
|
44486
44486
|
"preferredWhen": "For allocation-style questions about one company's posted/uninvoiced work — replaces the multi-call billing×time×ticket hand-join; companies.fullProfile for the general company picture; operations.aggregate for cross-resource existence/totals",
|
|
44487
44487
|
"related": [
|
|
44488
44488
|
"companies.fullProfile",
|
|
@@ -51651,7 +51651,7 @@ const CAPABILITY_DATA = {
|
|
|
51651
51651
|
},
|
|
51652
51652
|
"examples": [
|
|
51653
51653
|
"await client.configurationItems.create({ companyID: 1001, productID: 123, isActive: true }, { dryRun: true })",
|
|
51654
|
-
"
|
|
51654
|
+
"live wall (probes 500d on types 3/5/6): the body must set productID to an EXISTING Product (123 is illustrative — the tenant has none: products.count is 0, no enumerable id) — this create is UNAVAILABLE in tenants without products. The body documents the wall, not a working create."
|
|
51655
51655
|
],
|
|
51656
51656
|
"permissions": "unknown",
|
|
51657
51657
|
"pagination": {
|
|
@@ -51666,7 +51666,7 @@ const CAPABILITY_DATA = {
|
|
|
51666
51666
|
},
|
|
51667
51667
|
"metadata": {
|
|
51668
51668
|
"purpose": "Create a configuration item.",
|
|
51669
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Live wall: the body must set productID to an EXISTING Product; products.count is 0
|
|
51669
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Live wall: the body must set productID to an EXISTING Product; products.count is 0 (blind surface, no enumerable id) — this create is UNAVAILABLE in tenants without products. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
51670
51670
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
51671
51671
|
"related": [
|
|
51672
51672
|
"configuration_items.update"
|
|
@@ -52279,7 +52279,7 @@ const CAPABILITY_DATA = {
|
|
|
52279
52279
|
},
|
|
52280
52280
|
"examples": [
|
|
52281
52281
|
"await client.configurationItems.profile(1)",
|
|
52282
|
-
"Shape-only: NO CI record exists
|
|
52282
|
+
"Shape-only: NO CI record exists (the product wall blocked every create — products.count = 0), so the id is a placeholder and the op is mock-verified. args: (CI id, optional { noteLimit (default 50), relatedLimit (default 50) }). Wire: <=6 reads (get + type + category + 3 item-scoped queries; a dangling type/category FK skips its read). productAssociations is TYPED, never an error: on a tenant without enumerable products the part carries blind: true + the zone-facts note. CI missing → NOT_FOUND."
|
|
52283
52283
|
],
|
|
52284
52284
|
"permissions": "unknown",
|
|
52285
52285
|
"pagination": {
|
|
@@ -52294,7 +52294,7 @@ const CAPABILITY_DATA = {
|
|
|
52294
52294
|
},
|
|
52295
52295
|
"metadata": {
|
|
52296
52296
|
"purpose": "Get the full profile of one configuration item in a single call: the item, its type and category records, its notes, related items and billing-product associations.",
|
|
52297
|
-
"usage": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name sibling on the ci row (closed scope: the contract name — the CI row has no issue-listed picklist fields, so no labels) + the top-level `names` section; the sibling rides the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: <=6 reads (get + type + category + 3 item-scoped queries; a dangling type/category FK skips its read). With names: true, N added name reads (N = the distinct uncached FK ids, capped by maxNameReads). productAssociations: the raw association rows (billingProductID FK) + the typed product-wall annotation from the served zone facts (blind: true + note) on tenants without enumerable products (
|
|
52297
|
+
"usage": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name sibling on the ci row (closed scope: the contract name — the CI row has no issue-listed picklist fields, so no labels) + the top-level `names` section; the sibling rides the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: <=6 reads (get + type + category + 3 item-scoped queries; a dangling type/category FK skips its read). With names: true, N added name reads (N = the distinct uncached FK ids, capped by maxNameReads). productAssociations: the raw association rows (billingProductID FK) + the typed product-wall annotation from the served zone facts (blind: true + note) on tenants without enumerable products (products.count = 0) — never an error. CI missing → NOT_FOUND. On a productless tenant no CI record exists (the product wall blocked every create) — no CI exists there (the product wall is the boundary), so the op is mock-verified.",
|
|
52298
52298
|
"preferredWhen": "The single read for 'what is this configuration item' — replaces 5-6 raw reads + describes with one call.",
|
|
52299
52299
|
"related": [
|
|
52300
52300
|
"configuration_items.get",
|
|
@@ -53551,7 +53551,7 @@ const CAPABILITY_DATA = {
|
|
|
53551
53551
|
},
|
|
53552
53552
|
"examples": [
|
|
53553
53553
|
"await client.contacts.create(1001, { firstName: 'Jane', lastName: 'Doe', companyID: 1001, isActive: 1 }, { dryRun: true })",
|
|
53554
|
-
"
|
|
53554
|
+
"validated required set: firstName, lastName, companyID, isActive — isActive is a NUMBER (1/0), not a boolean (a JSON boolean 500s at the vendor parse layer). The create is parent-scoped (the company id rides the scoped path + the body)."
|
|
53555
53555
|
],
|
|
53556
53556
|
"permissions": "unknown",
|
|
53557
53557
|
"pagination": {
|
|
@@ -53566,7 +53566,7 @@ const CAPABILITY_DATA = {
|
|
|
53566
53566
|
},
|
|
53567
53567
|
"metadata": {
|
|
53568
53568
|
"purpose": "Create a contact. (under a company)",
|
|
53569
|
-
"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. Live-required: firstName, lastName, companyID, isActive — isActive is a NUMBER (1), not a boolean
|
|
53569
|
+
"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. Live-required: firstName, lastName, companyID, isActive — isActive is a NUMBER (1), not a boolean; the spec declares no required fields.",
|
|
53570
53570
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
53571
53571
|
"related": [
|
|
53572
53572
|
"contacts.update"
|
|
@@ -54770,7 +54770,7 @@ const CAPABILITY_DATA = {
|
|
|
54770
54770
|
},
|
|
54771
54771
|
"metadata": {
|
|
54772
54772
|
"purpose": "Update a contact. (under a company)",
|
|
54773
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. isActive is a NUMBER (1/0)
|
|
54773
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. isActive is a NUMBER (1/0) — a JSON boolean 500s at the vendor parse layer (ContactModel; LocationModel takes a boolean).",
|
|
54774
54774
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
54775
54775
|
"related": [
|
|
54776
54776
|
"contacts.get"
|
|
@@ -69645,7 +69645,7 @@ const CAPABILITY_DATA = {
|
|
|
69645
69645
|
},
|
|
69646
69646
|
"examples": [
|
|
69647
69647
|
"await client.projects.create({ projectName: 'Example', description: 'Example', companyID: 0, projectType: 2, status: 1, startDateTime: '2026-10-03T00:00:00Z', endDateTime: '2026-10-10T00:00:00Z' }, { dryRun: true })",
|
|
69648
|
-
"
|
|
69648
|
+
"validated: created a project with this full proven body (companyID 0 = tenant-global; project 8002 was a sample record, never-mutated fixture reference). Per-field minimality was not isolated live — keep the full shape."
|
|
69649
69649
|
],
|
|
69650
69650
|
"permissions": "unknown",
|
|
69651
69651
|
"pagination": {
|
|
@@ -73938,7 +73938,7 @@ const CAPABILITY_DATA = {
|
|
|
73938
73938
|
},
|
|
73939
73939
|
"examples": [
|
|
73940
73940
|
"await client.tasks.create(8001, { title: 'Example', projectID: 8001, taskType: 1, status: 1 }, { dryRun: true })",
|
|
73941
|
-
"
|
|
73941
|
+
"verified: created task 7003 with this body under project 8001 (the DEL-GAP fixture — FK/read only, never mutated). projectID is REQUIRED IN THE BODY (the scoped parent path carries the parent too); taskType is an integer picklist (1/2); a missing required field 500s with a typed field-level error."
|
|
73942
73942
|
],
|
|
73943
73943
|
"permissions": "unknown",
|
|
73944
73944
|
"pagination": {
|
|
@@ -77705,7 +77705,7 @@ const CAPABILITY_DATA = {
|
|
|
77705
77705
|
},
|
|
77706
77706
|
"metadata": {
|
|
77707
77707
|
"purpose": "Update a ticket charge.",
|
|
77708
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. ticketID does NOT persist on update (success returned, old ticketID kept; probed live
|
|
77708
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. ticketID does NOT persist on update (success returned, old ticketID kept; probed live, 2026-10-21). To re-parent use ticket_charges.moveToTicket (create, verify, delete).",
|
|
77709
77709
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change. Not for ticketID: use ticket_charges.moveToTicket.",
|
|
77710
77710
|
"related": [
|
|
77711
77711
|
"ticket_charges.get"
|
|
@@ -78758,8 +78758,8 @@ const CAPABILITY_DATA = {
|
|
|
78758
78758
|
"drops": []
|
|
78759
78759
|
},
|
|
78760
78760
|
"examples": [
|
|
78761
|
-
"await client.ticketNotes.create(7001, { description: 'Example', noteType: 1, publish: 1 }, { dryRun: true })",
|
|
78762
|
-
"
|
|
78761
|
+
"await client.ticketNotes.create(7001, { description: 'Example', noteType: 1, publish: 1, title: 'Example' }, { dryRun: true })",
|
|
78762
|
+
"validated: a title-less note was created under ticket 7001; with a title the create succeeds and without one the vendor refuses (body verbatim: \"Missing Required Field: title.\"); publish is an INTEGER picklist (1/2/4), NOT a boolean (a JSON boolean 500s); noteType is an integer; ticketID is NOT in the body (the scoped parent path supplies it)."
|
|
78763
78763
|
],
|
|
78764
78764
|
"permissions": "unknown",
|
|
78765
78765
|
"pagination": {
|
|
@@ -78774,7 +78774,7 @@ const CAPABILITY_DATA = {
|
|
|
78774
78774
|
},
|
|
78775
78775
|
"metadata": {
|
|
78776
78776
|
"purpose": "Create a ticket note.",
|
|
78777
|
-
"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. publish is an integer picklist (1/2/4) and noteType is an integer — both INT, a JSON boolean 500s at the vendor parse layer. Live-required: description, noteType, publish; ticketID is NOT in the body (the scoped parent path supplies it)
|
|
78777
|
+
"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. publish is an integer picklist (1/2/4) and noteType is an integer — both INT, a JSON boolean 500s at the vendor parse layer. Live-required: description, noteType, publish, title; ticketID is NOT in the body (the scoped parent path supplies it). A title-less create is refused by the vendor (\"Missing Required Field: title.\"); a create with title succeeded. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
78778
78778
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
78779
78779
|
"related": [
|
|
78780
78780
|
"ticket_notes.update"
|
|
@@ -79234,7 +79234,7 @@ const CAPABILITY_DATA = {
|
|
|
79234
79234
|
},
|
|
79235
79235
|
"metadata": {
|
|
79236
79236
|
"purpose": "Update a ticket note.",
|
|
79237
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. Setting ticketID in the body MOVES the note: the parent-scoped update (oldTicketID, noteId, { ticketID: newTicketID }) persists (probed live
|
|
79237
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. Setting ticketID in the body MOVES the note: the parent-scoped update (oldTicketID, noteId, { ticketID: newTicketID }) persists (probed live, 2026-10-21). There is no unscoped route (404) and notes cannot be deleted (405), so a note is never moved by create-then-delete. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
79238
79238
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
79239
79239
|
"related": [
|
|
79240
79240
|
"ticket_notes.get"
|
|
@@ -80515,7 +80515,7 @@ const CAPABILITY_DATA = {
|
|
|
80515
80515
|
},
|
|
80516
80516
|
"examples": [
|
|
80517
80517
|
"await client.tickets.changeStatus(7002, 14, {}, { dryRun: true })",
|
|
80518
|
-
"
|
|
80518
|
+
"args (ticket id, targetStatus from the tenant's LIVE status picklist (the entity metadata is the oracle; the values + labels are discoverable with operations.fieldCatalog({ resources: [tickets], fields: [status], labels: true })), optional caller fields, opts). The node validates the status pre-request against the live picklist (the vendor's own validation decides when the metadata is unavailable), merges the current record (one GET) and fills the proven-safe defaults for the fields the target status requires that the record lacks (the per-status map is live-discovered vendor state). current === target → typed NO_CHANGE (zero mutating wire). 7002 = a sample ticket (verified present); dry-run shown — apply mutates the ticket."
|
|
80519
80519
|
],
|
|
80520
80520
|
"permissions": "unknown",
|
|
80521
80521
|
"pagination": {
|
|
@@ -80623,7 +80623,7 @@ const CAPABILITY_DATA = {
|
|
|
80623
80623
|
},
|
|
80624
80624
|
"metadata": {
|
|
80625
80625
|
"purpose": "Count ticket records matching a JSON filter.",
|
|
80626
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
80626
|
+
"usage": "Unwraps queryCount; returns a plain number. Vendor quirk: count/query return 0/empty on this surface (0 before AND after a proven live create) — verify presence with get(id), not count.",
|
|
80627
80627
|
"preferredWhen": null,
|
|
80628
80628
|
"related": [
|
|
80629
80629
|
"tickets.query"
|
|
@@ -80694,7 +80694,7 @@ const CAPABILITY_DATA = {
|
|
|
80694
80694
|
},
|
|
80695
80695
|
"examples": [
|
|
80696
80696
|
"await client.tickets.create({ title: 'Example', status: 1, priority: 3, companyID: 1001, queueID: 3001 }, { dryRun: true })",
|
|
80697
|
-
"
|
|
80697
|
+
"validated: created a ticket with exactly this field set (companyID anonymized to the fixture company 1001). A body missing any of title/status/priority/companyID/queueID 500s with a typed field-level error."
|
|
80698
80698
|
],
|
|
80699
80699
|
"permissions": "unknown",
|
|
80700
80700
|
"pagination": {
|
|
@@ -81051,7 +81051,7 @@ const CAPABILITY_DATA = {
|
|
|
81051
81051
|
},
|
|
81052
81052
|
"examples": [
|
|
81053
81053
|
"await client.tickets.fullContext(7002)",
|
|
81054
|
-
"
|
|
81054
|
+
"validated: a run served 7002 in 5 wire (ticket + company part + 3 scoped queries; the dangling FK parts were 'absent'; 5 notes; long text capped at the default textLimit and flagged). args: (ticket id, optional { noteLimit (default 50), timeEntryLimit (default 50), includeAttachments (default true — metadata only: ids + names), includeHistories (default false), textLimit (default 500) }). Wire: 8 bounded reads (10 with histories). A missing/dangling FK part is null + 'absent' — a part miss never fails the op; the ticket itself missing → NOT_FOUND."
|
|
81055
81055
|
],
|
|
81056
81056
|
"permissions": "unknown",
|
|
81057
81057
|
"pagination": {
|
|
@@ -81731,7 +81731,7 @@ const CAPABILITY_DATA = {
|
|
|
81731
81731
|
},
|
|
81732
81732
|
"metadata": {
|
|
81733
81733
|
"purpose": "Query Ticket records with a JSON filter.",
|
|
81734
|
-
"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).
|
|
81734
|
+
"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). Vendor quirk: count/query return 0/empty on this surface (0 before AND after a proven live create) — verify presence with get(id), not count. 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.",
|
|
81735
81735
|
"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).",
|
|
81736
81736
|
"related": [
|
|
81737
81737
|
"tickets.resolve"
|
|
@@ -82480,8 +82480,8 @@ const CAPABILITY_DATA = {
|
|
|
82480
82480
|
]
|
|
82481
82481
|
},
|
|
82482
82482
|
"operations": {
|
|
82483
|
-
"planHash": "
|
|
82484
|
-
"builtAt": "2026-11-
|
|
82483
|
+
"planHash": "546e9de78d62f2c30190c1bb82f89be73f9cc0a75d633d771956566c78f4efeb",
|
|
82484
|
+
"builtAt": "2026-11-17T02:57:12.896Z",
|
|
82485
82485
|
"records": [
|
|
82486
82486
|
{
|
|
82487
82487
|
"id": "operations.aggregate",
|
|
@@ -82721,7 +82721,7 @@ const CAPABILITY_DATA = {
|
|
|
82721
82721
|
"operations.relationshipMap",
|
|
82722
82722
|
"autotask_catalog"
|
|
82723
82723
|
],
|
|
82724
|
-
"args": "args[0] is the optional opts object: { resources?: string[] (plan keys), kind?: CreateBlockerKind }. Zero wire — the answer is the served, drift-guarded campaign artifact (92 create entities
|
|
82724
|
+
"args": "args[0] is the optional opts object: { resources?: string[] (plan keys), kind?: CreateBlockerKind }. Zero wire — the answer is the served, drift-guarded campaign artifact (92 create entities). Unknown resource → typed RESOURCE_UNKNOWN (count + autotask_catalog pointer); unknown kind → typed CONFIG_ERROR naming the valid kinds."
|
|
82725
82725
|
},
|
|
82726
82726
|
"compact": "CreateGuidanceReport",
|
|
82727
82727
|
"status": "tested"
|
|
@@ -83255,7 +83255,7 @@ const CAPABILITY_DATA = {
|
|
|
83255
83255
|
},
|
|
83256
83256
|
"examples": [
|
|
83257
83257
|
"await invoke(client, 'operations.relationshipMap', ['tickets'])",
|
|
83258
|
-
"
|
|
83258
|
+
"validated: a run served the tickets entry ZERO wire (its 10 scoped children with scoped-op flags + the unowned-blind stamps). args (invoke form): the plan resource key string. Returns { resource, apiEntity, tier, parent, children [{ resource, parentField, scopedOps { create, query, update, delete }, specialOps }], naturalKeys, blindSurfaces, zoneFacts }. 'What can I attach to a ticket?' → children; 'what does creating a ticket note require?' → relationshipMap('ticket_notes').zoneFacts.createRequiredSet = [description, noteType, publish, title]. Unknown key → typed RESOURCE_UNKNOWN (carries the resource count + a pointer to autotask_catalog). ZERO vendor wire by construction — the data is the served registry artifact."
|
|
83259
83259
|
],
|
|
83260
83260
|
"permissions": "unknown",
|
|
83261
83261
|
"pagination": {
|
|
@@ -83270,8 +83270,8 @@ const CAPABILITY_DATA = {
|
|
|
83270
83270
|
},
|
|
83271
83271
|
"metadata": {
|
|
83272
83272
|
"purpose": "Describe one resource's full relationship surface in a single ZERO-wire call: its parent, its children (with the scoped-op presence per child), its natural lookup keys, its pinned blind surfaces, and the zone-verified create required sets + quirks.",
|
|
83273
|
-
"usage": "args[0] is the plan resource key (string, e.g. 'tickets'). Returns { resource, apiEntity, tier, workflowResource, parent, children: [{ resource, apiEntity, parentField, parentSegment, scopedOps: { create, query, update, delete }, specialOps, searchCovers }], naturalKeys: { hasSearch, searchCovers, findBy }, blindSurfaces, zoneFacts }. 'What can I attach to a ticket?' → children of 'tickets' (the 10 scoped child resources with their scoped-op flags); 'what does creating a ticket note require?' → relationshipMap('ticket_notes').zoneFacts.createRequiredSet = [description, noteType, publish]. Unknown key → typed RESOURCE_UNKNOWN (carries the resource count + a pointer to autotask_catalog — never a 128-key dump). ZERO vendor wire: the data is the plan-pinned registry artifact (the zone facts are the verified set — the zone label travels with them).",
|
|
83274
|
-
"preferredWhen": "The first call when planning any multi-step composition (what exists under this resource, what a create requires, which surfaces are blind
|
|
83273
|
+
"usage": "args[0] is the plan resource key (string, e.g. 'tickets'). Returns { resource, apiEntity, tier, workflowResource, parent, children: [{ resource, apiEntity, parentField, parentSegment, scopedOps: { create, query, update, delete }, specialOps, searchCovers }], naturalKeys: { hasSearch, searchCovers, findBy }, blindSurfaces, zoneFacts }. 'What can I attach to a ticket?' → children of 'tickets' (the 10 scoped child resources with their scoped-op flags); 'what does creating a ticket note require?' → relationshipMap('ticket_notes').zoneFacts.createRequiredSet = [description, noteType, publish, title]. Unknown key → typed RESOURCE_UNKNOWN (carries the resource count + a pointer to autotask_catalog — never a 128-key dump). ZERO vendor wire: the data is the plan-pinned registry artifact (the zone facts are the verified set — the zone label travels with them).",
|
|
83274
|
+
"preferredWhen": "The first call when planning any multi-step composition (what exists under this resource, what a create requires, which surfaces are blind) — zero wire, so it is free to consult before every plan. For a live record, use the resource's read ops.",
|
|
83275
83275
|
"related": [
|
|
83276
83276
|
"operations.resolveAny",
|
|
83277
83277
|
"autotask_catalog"
|
package/dist/capabilities.cjs
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkWKR5IJEC_cjs = require('./chunk-WKR5IJEC.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 chunkWKR5IJEC_cjs.CAPABILITY_PLAN_HASHES; }
|
|
10
10
|
});
|
|
11
11
|
Object.defineProperty(exports, "loadCapabilities", {
|
|
12
12
|
enumerable: true,
|
|
13
|
-
get: function () { return
|
|
13
|
+
get: function () { return chunkWKR5IJEC_cjs.loadCapabilities; }
|
|
14
14
|
});
|
|
15
15
|
Object.defineProperty(exports, "loadCapabilityRecords", {
|
|
16
16
|
enumerable: true,
|
|
17
|
-
get: function () { return
|
|
17
|
+
get: function () { return chunkWKR5IJEC_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-N4EO3KAY.js';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ConfigurationItemsResource, ContactsResource, InventoryProductsResource, QuotesResource, ResourceTimeOffAdditionalResource, ResourceTimeOffBalancesResource, ResourcesResource, ServiceCallsResource, TicketChargesResource, TicketsResource, TimeOffRequestsResource, AuthenticateResource, EntityInformationResource, ModulesResource, ThresholdInformationResource, VersionResource, VersionInformationResource, ZoneInformationResource } from './chunk-
|
|
2
|
-
import { resolveConfig, HttpClient, SIMPLE_RESOURCES, GenericResource, CompaniesResource, ContractsResource, InvoicesResource, TimeEntriesResource, runWithSignal, AutotaskConfigError } from './chunk-
|
|
1
|
+
import { ConfigurationItemsResource, ContactsResource, InventoryProductsResource, QuotesResource, ResourceTimeOffAdditionalResource, ResourceTimeOffBalancesResource, ResourcesResource, ServiceCallsResource, TicketChargesResource, TicketsResource, TimeOffRequestsResource, AuthenticateResource, EntityInformationResource, ModulesResource, ThresholdInformationResource, VersionResource, VersionInformationResource, ZoneInformationResource } from './chunk-MXLE2F5G.js';
|
|
2
|
+
import { resolveConfig, HttpClient, SIMPLE_RESOURCES, GenericResource, CompaniesResource, ContractsResource, InvoicesResource, TimeEntriesResource, runWithSignal, AutotaskConfigError } from './chunk-ULI4UUB3.js';
|
|
3
3
|
|
|
4
4
|
// src/client.ts
|
|
5
5
|
var AutotaskClient = class {
|