node-autotask 0.66.0 → 0.68.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 +16 -0
- package/MCP_TOOL_CATALOG.json +28 -9
- package/README.md +1 -1
- package/capabilities.json +107 -8
- package/dist/capabilities-data.js +106 -7
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-4HJVHVPE.js → chunk-BF22HBNT.js} +2 -2
- package/dist/{chunk-XAJ7SBPE.cjs → chunk-CG6OPTFG.cjs} +31 -31
- package/dist/{chunk-KO36QZXN.js → chunk-DPJLN5BB.js} +2599 -2306
- package/dist/{chunk-QG3O5G4L.cjs → chunk-HFWOHUVF.cjs} +173 -173
- package/dist/{chunk-L5K2D2MZ.js → chunk-JCMXQUIC.js} +3 -3
- package/dist/{chunk-T5TI22K5.js → chunk-OUVUQQXH.js} +2 -2
- package/dist/{chunk-FLVMENXG.cjs → chunk-SGH7F2CH.cjs} +3 -3
- package/dist/{chunk-TIFJFCCN.cjs → chunk-V2GE763R.cjs} +2603 -2309
- package/dist/{index-BZ11hF8H.d.ts → index-DQ08uOH0.d.ts} +45 -5
- package/dist/{index-DnisYPlj.d.cts → index-mIsdpO5d.d.cts} +45 -5
- 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 +29 -11
- package/dist/pool.js +25 -7
- 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/API.md +3 -3
- package/docs/VENDOR-QUIRKS.md +32 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.68.0] - 2026-11-17
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- `companies.searchFuzzy` combines an uncached live fragment query with a background company-name index for typo-tolerant candidate discovery (#453). Adjacent swapped letters count as one typo. Results include coverage, edit distance, source, index state and truncation; active companies are the default, with optional inactive and family inclusion. The SDK-owned index refreshes every 30 minutes (configurable via `cache.companyIndexTtlMs`) and after company mutations; `cache: false` disables it.
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- Share accent, ampersand and legal-suffix normalisation between company fuzzy search and CRM dedupe while preserving meaningful conjunctions in dedupe.
|
|
19
|
+
|
|
20
|
+
## [0.67.0] - 2026-11-17
|
|
21
|
+
|
|
22
|
+
### Fixed
|
|
23
|
+
|
|
24
|
+
- Prevent zone-scoped capability guidance with a structured-quirk hygiene check that covers numeric zone identifiers and keeps region/date provenance in evidence (#451). Remove the remaining zone qualifier from the contacts `isActive` wire-type guidance while preserving the field constraint and its original evidence. Shared API contracts do not imply shared tenant inventory or API-user visibility.
|
|
25
|
+
|
|
10
26
|
## [0.66.0] - 2026-11-17
|
|
11
27
|
|
|
12
28
|
### Fixed
|
package/MCP_TOOL_CATALOG.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"generatedBy": "scripts/build-tool-catalog.mjs",
|
|
3
|
-
"generatedAt": "2026-11-
|
|
4
|
-
"planHash": "
|
|
3
|
+
"generatedAt": "2026-11-17T07:46:23.435Z",
|
|
4
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
5
5
|
"metaTools": [
|
|
6
6
|
{
|
|
7
7
|
"name": "autotask_catalog",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
{
|
|
52
52
|
"name": "autotask_read",
|
|
53
53
|
"title": "Read One Registry Operation (read mode)",
|
|
54
|
-
"description": "Route an effect=read registry operation by its exact name (never fuzzy, never a tool name): the 390 field/entity/UDF-info reads (getEntityInfo/getFieldInfo/getUdfInfo) have no dedicated tool and ride this one, and any read op is routable. For field discovery use operations.fieldCatalog (compact) instead of per-resource getFieldInfo (full dump). Read-only by construction — every op it can route is effect=read (zero mutating requests), and a write or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Reads have no dry run (a read with dry_run: true is refused). Harness approval policy: approve every tool with readOnlyHint !== true (exactly 252 today); the
|
|
54
|
+
"description": "Route an effect=read registry operation by its exact name (never fuzzy, never a tool name): the 390 field/entity/UDF-info reads (getEntityInfo/getFieldInfo/getUdfInfo) have no dedicated tool and ride this one, and any read op is routable. For field discovery use operations.fieldCatalog (compact) instead of per-resource getFieldInfo (full dump). Read-only by construction — every op it can route is effect=read (zero mutating requests), and a write or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Reads have no dry run (a read with dry_run: true is refused). Harness approval policy: approve every tool with readOnlyHint !== true (exactly 252 today); the 611 readOnlyHint: true tools — including this one — are safe ungated; the 57 destructiveHint: true tools (56 dedicated delete tools + autotask_delete) require confirm === the operation key. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. For query/count ops args[0] is a params object (filter/limit); call autotask_describe first for the exact arg shape and filter grammar. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
55
55
|
"input": {
|
|
56
56
|
"operation": {
|
|
57
57
|
"type": "string",
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
{
|
|
72
72
|
"name": "autotask_write",
|
|
73
73
|
"title": "Write One Registry Operation (write mode)",
|
|
74
|
-
"description": "Route an effect=write registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true — the mutating request is never issued); pass dry_run: false to apply. A read or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). The 2 approval-gated writes (configuration_items.moveConfigurationItem, contacts.moveToCompany) additionally require confirm === the operation key, in BOTH dry-run and apply mode. Harness approval policy: this tool is one of the 252 tools that require approval (readOnlyHint !== true); the
|
|
74
|
+
"description": "Route an effect=write registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true — the mutating request is never issued); pass dry_run: false to apply. A read or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). The 2 approval-gated writes (configuration_items.moveConfigurationItem, contacts.moveToCompany) additionally require confirm === the operation key, in BOTH dry-run and apply mode. Harness approval policy: this tool is one of the 252 tools that require approval (readOnlyHint !== true); the 611 readOnlyHint: true tools are safe ungated, and the 57 destructiveHint: true tools (56 dedicated delete tools + autotask_delete) require confirm === the operation key. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. For query/count ops args[0] is a params object (filter/limit); call autotask_describe first for the exact arg shape and filter grammar. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
75
75
|
"input": {
|
|
76
76
|
"operation": {
|
|
77
77
|
"type": "string",
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
{
|
|
102
102
|
"name": "autotask_delete",
|
|
103
103
|
"title": "Delete One Registry Operation (delete mode)",
|
|
104
|
-
"description": "Route an effect=destructive (delete) registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true); pass dry_run: false to apply. confirm === the operation key is REQUIRED for every delete (all 56), in BOTH dry-run and apply mode — the deliberate act is the call, not the delete. A read or write op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Harness approval policy: this tool is one of the 57 destructiveHint: true tools that require approval + confirm; approve every tool with readOnlyHint !== true (exactly 252 today); the
|
|
104
|
+
"description": "Route an effect=destructive (delete) registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true); pass dry_run: false to apply. confirm === the operation key is REQUIRED for every delete (all 56), in BOTH dry-run and apply mode — the deliberate act is the call, not the delete. A read or write op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Harness approval policy: this tool is one of the 57 destructiveHint: true tools that require approval + confirm; approve every tool with readOnlyHint !== true (exactly 252 today); the 611 readOnlyHint: true tools are safe ungated. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
105
105
|
"input": {
|
|
106
106
|
"operation": {
|
|
107
107
|
"type": "string",
|
|
@@ -12301,7 +12301,7 @@
|
|
|
12301
12301
|
"core": false,
|
|
12302
12302
|
"tool": "autotask_company_search",
|
|
12303
12303
|
"purpose": "Search company records by text (contains on the searchable fields).",
|
|
12304
|
-
"preferredWhen": "
|
|
12304
|
+
"preferredWhen": "Substring names, abbreviations and family lookups. For typo tolerance use companies.searchFuzzy; exact matching remains companies.resolve.",
|
|
12305
12305
|
"backingOperation": "companies.search",
|
|
12306
12306
|
"effect": "read",
|
|
12307
12307
|
"dryRunFirst": false,
|
|
@@ -12353,6 +12353,25 @@
|
|
|
12353
12353
|
"reachReason": null,
|
|
12354
12354
|
"boundedAlternative": null
|
|
12355
12355
|
},
|
|
12356
|
+
{
|
|
12357
|
+
"operation": "companies.searchFuzzy",
|
|
12358
|
+
"core": false,
|
|
12359
|
+
"tool": "autotask_company_searchFuzzy",
|
|
12360
|
+
"purpose": "Find company candidates despite misspelt names; never infer an exact identity from a fuzzy candidate.",
|
|
12361
|
+
"preferredWhen": "A company name may contain typos. Use companies.resolve for exact identity and ask the caller to confirm fuzzy candidates.",
|
|
12362
|
+
"backingOperation": "companies.searchFuzzy",
|
|
12363
|
+
"effect": "read",
|
|
12364
|
+
"dryRunFirst": false,
|
|
12365
|
+
"confirm": false,
|
|
12366
|
+
"requiredArgs": [
|
|
12367
|
+
"query"
|
|
12368
|
+
],
|
|
12369
|
+
"tier": "core",
|
|
12370
|
+
"reachable": true,
|
|
12371
|
+
"reach": "dedicated tool",
|
|
12372
|
+
"reachReason": null,
|
|
12373
|
+
"boundedAlternative": null
|
|
12374
|
+
},
|
|
12356
12375
|
{
|
|
12357
12376
|
"operation": "companies.unbilledWork",
|
|
12358
12377
|
"core": false,
|
|
@@ -22939,10 +22958,10 @@
|
|
|
22939
22958
|
}
|
|
22940
22959
|
],
|
|
22941
22960
|
"counts": {
|
|
22942
|
-
"registryOperations":
|
|
22961
|
+
"registryOperations": 1248,
|
|
22943
22962
|
"coreOperations": 10,
|
|
22944
|
-
"catalogRows":
|
|
22945
|
-
"withTool":
|
|
22963
|
+
"catalogRows": 1248,
|
|
22964
|
+
"withTool": 858,
|
|
22946
22965
|
"readModeOnly": 390,
|
|
22947
22966
|
"neverExposed": 0,
|
|
22948
22967
|
"metaTools": 5
|
package/README.md
CHANGED
|
@@ -342,7 +342,7 @@ The SDK ships the mechanical substrate, not a server (no MCP imports, no zod):
|
|
|
342
342
|
governor place: `src/operations/invoke.ts`).
|
|
343
343
|
|
|
344
344
|
<!-- BEGIN GENERATED:approval-policy -->
|
|
345
|
-
**Harness approval policy (recommended).** Require approval on every tool whose MCP annotation is `readOnlyHint !== true` — today exactly **252 tools**: the 250 dedicated write/delete tools (194 `effect=write` + 56 `effect=destructive`, every one of them has a dedicated tool) + `autotask_write` + `autotask_delete`. The remaining **
|
|
345
|
+
**Harness approval policy (recommended).** Require approval on every tool whose MCP annotation is `readOnlyHint !== true` — today exactly **252 tools**: the 250 dedicated write/delete tools (194 `effect=write` + 56 `effect=destructive`, every one of them has a dedicated tool) + `autotask_write` + `autotask_delete`. The remaining **611 tools** (the 598 dedicated read tools + the 10 core read tools + `autotask_read` + `autotask_catalog` + `autotask_describe`) all carry `readOnlyHint: true` and are safe ungated: every op they can route is `effect=read` (zero mutating requests). Refined class for the highest-risk ops: the **57 tools with `destructiveHint: true`** (56 dedicated delete tools + `autotask_delete`) additionally require `confirm === <operation key>` even inside `autotask_delete`. The approval-gated writes (`configuration_items.moveConfigurationItem`, `contacts.moveToCompany`) require the same confirm inside `autotask_write`. Migration: `autotask_invoke` is REPLACED by `autotask_read`/`autotask_write`/`autotask_delete` — update harness config and remove any `autotask_invoke` entry. The rule is derivable from the registry `effect` column and the mode tools’ fixed annotations; it never needs a hand-maintained name list.
|
|
346
346
|
<!-- END GENERATED:approval-policy -->
|
|
347
347
|
**Provider tool-search interop.** Hosts with provider-native tool search
|
|
348
348
|
(OpenAI `type: "tool_search"` / `defer_loading`; Anthropic's tool search
|
package/capabilities.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-11-
|
|
2
|
+
"generatedAt": "2026-11-17T07:45:52.876Z",
|
|
3
3
|
"groups": {
|
|
4
4
|
"B": {
|
|
5
|
-
"planHash": "
|
|
6
|
-
"builtAt": "2026-11-
|
|
5
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
6
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
7
7
|
"records": [
|
|
8
8
|
{
|
|
9
9
|
"id": "appointments.count",
|
|
@@ -42786,8 +42786,8 @@
|
|
|
42786
42786
|
]
|
|
42787
42787
|
},
|
|
42788
42788
|
"A": {
|
|
42789
|
-
"planHash": "
|
|
42790
|
-
"builtAt": "2026-11-
|
|
42789
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
42790
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
42791
42791
|
"records": [
|
|
42792
42792
|
{
|
|
42793
42793
|
"id": "companies.count",
|
|
@@ -43877,7 +43877,7 @@
|
|
|
43877
43877
|
"metadata": {
|
|
43878
43878
|
"purpose": "Search company records by text (contains on the searchable fields).",
|
|
43879
43879
|
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: companyName only (contains); no vendor free-text search exists. limit defaults to 25, max 500. opts is a CLOSED bag (an unknown key is refused pre-request, zero wire — the valid keys: limit, includeFamily). includeFamily?: boolean (default false): each returned match gains a family block { parentID (the match's own parentCompanyID — zero extra wire: the field is on the returned row; null when absent), childIDs (ONE bounded single-page query per match — parentCompanyID eq, MaxRecords 50 — the vendor field casing; childIDsTruncated when that page came back full with a live next cursor — a short page or a full page with a null cursor is complete), blindNote (the plan-pinned blind-surface caveat: companies.query is unowned-blind — the family, and the search hits themselves, are scoped to the caller-visible enumeration — a family is reported as SEEN BY THIS API USER, never as complete) }. Wire cost: 1 (the search) + matches × 1 (the child queries) — with the default limit 25 that is <= 26 wire; lower limit for large candidate sets.",
|
|
43880
|
-
"preferredWhen": "
|
|
43880
|
+
"preferredWhen": "Substring names, abbreviations and family lookups. For typo tolerance use companies.searchFuzzy; exact matching remains companies.resolve.",
|
|
43881
43881
|
"related": [
|
|
43882
43882
|
"companies.resolve",
|
|
43883
43883
|
"companies.query"
|
|
@@ -44094,6 +44094,105 @@
|
|
|
44094
44094
|
"compact": "CompanySummary",
|
|
44095
44095
|
"status": "tested"
|
|
44096
44096
|
},
|
|
44097
|
+
{
|
|
44098
|
+
"id": "companies.searchFuzzy",
|
|
44099
|
+
"resource": "companies",
|
|
44100
|
+
"udfCapable": true,
|
|
44101
|
+
"operation": "searchFuzzy",
|
|
44102
|
+
"kind": "helper",
|
|
44103
|
+
"endpoint": null,
|
|
44104
|
+
"effect": "read",
|
|
44105
|
+
"flags": [],
|
|
44106
|
+
"dryRun": false,
|
|
44107
|
+
"envelope": null,
|
|
44108
|
+
"inputSchema": {
|
|
44109
|
+
"query": {
|
|
44110
|
+
"type": "string",
|
|
44111
|
+
"required": true,
|
|
44112
|
+
"description": "Company name to match despite typos (at most 1000 characters and 16 distinct meaningful terms)."
|
|
44113
|
+
},
|
|
44114
|
+
"opts": {
|
|
44115
|
+
"type": "object",
|
|
44116
|
+
"required": false,
|
|
44117
|
+
"description": "CompanyFuzzySearchOptions — { limit?: number (1..10, default 10), includeFamily?: boolean, includeInactive?: boolean (default false) }. Returns { items: [{ record, distance, matchedTerms, coverage, source }], tier, truncated, pieces, index: { state, builtAt? } }; every row is a candidate to confirm.",
|
|
44118
|
+
"properties": [
|
|
44119
|
+
{
|
|
44120
|
+
"name": "limit",
|
|
44121
|
+
"type": "number",
|
|
44122
|
+
"optional": true,
|
|
44123
|
+
"default": 10
|
|
44124
|
+
},
|
|
44125
|
+
{
|
|
44126
|
+
"name": "includeFamily",
|
|
44127
|
+
"type": "boolean",
|
|
44128
|
+
"optional": true
|
|
44129
|
+
},
|
|
44130
|
+
{
|
|
44131
|
+
"name": "includeInactive",
|
|
44132
|
+
"type": "boolean",
|
|
44133
|
+
"optional": true,
|
|
44134
|
+
"default": false
|
|
44135
|
+
}
|
|
44136
|
+
]
|
|
44137
|
+
}
|
|
44138
|
+
},
|
|
44139
|
+
"inputSchemaStrict": true,
|
|
44140
|
+
"outputSchema": {
|
|
44141
|
+
"type": "CompanyFuzzySearchResult",
|
|
44142
|
+
"drops": []
|
|
44143
|
+
},
|
|
44144
|
+
"examples": [
|
|
44145
|
+
"await client.companies.searchFuzzy('example')"
|
|
44146
|
+
],
|
|
44147
|
+
"permissions": "unknown",
|
|
44148
|
+
"pagination": {
|
|
44149
|
+
"mode": "none"
|
|
44150
|
+
},
|
|
44151
|
+
"resolution": null,
|
|
44152
|
+
"retry": {
|
|
44153
|
+
"preset": "retry-ffb3a9cb"
|
|
44154
|
+
},
|
|
44155
|
+
"errors": {
|
|
44156
|
+
"set": 5
|
|
44157
|
+
},
|
|
44158
|
+
"metadata": {
|
|
44159
|
+
"purpose": "Find company candidates despite misspelt names; never infer an exact identity from a fuzzy candidate.",
|
|
44160
|
+
"usage": "Always performs one uncached live fragment query capped at 500 rows. The SDK lazily builds a separate slim company-name index in the background, refreshes it every 30 minutes and after company writes, and merges it with live results when warm. cache: false disables the index. Candidates are ranked by query-term coverage, Damerau edit distance (adjacent transposition counts as one), then active status. Active only unless includeInactive is true. Live fragments have bounded recall; inspect tier, truncated and index.state before interpreting a miss.",
|
|
44161
|
+
"preferredWhen": "A company name may contain typos. Use companies.resolve for exact identity and ask the caller to confirm fuzzy candidates.",
|
|
44162
|
+
"related": [
|
|
44163
|
+
"companies.resolve",
|
|
44164
|
+
"companies.search"
|
|
44165
|
+
],
|
|
44166
|
+
"untrustedFields": [
|
|
44167
|
+
"UDF1",
|
|
44168
|
+
"UDF10",
|
|
44169
|
+
"UDF11",
|
|
44170
|
+
"UDF12",
|
|
44171
|
+
"UDF13",
|
|
44172
|
+
"UDF14",
|
|
44173
|
+
"UDF15",
|
|
44174
|
+
"UDF16",
|
|
44175
|
+
"UDF17",
|
|
44176
|
+
"UDF18",
|
|
44177
|
+
"UDF19",
|
|
44178
|
+
"UDF2",
|
|
44179
|
+
"UDF20",
|
|
44180
|
+
"UDF3",
|
|
44181
|
+
"UDF4",
|
|
44182
|
+
"UDF5",
|
|
44183
|
+
"UDF6",
|
|
44184
|
+
"UDF7",
|
|
44185
|
+
"UDF8",
|
|
44186
|
+
"UDF9",
|
|
44187
|
+
"billToAttention",
|
|
44188
|
+
"companyName",
|
|
44189
|
+
"stockMarket",
|
|
44190
|
+
"stockSymbol"
|
|
44191
|
+
]
|
|
44192
|
+
},
|
|
44193
|
+
"compact": "CompanyFuzzySearchResult",
|
|
44194
|
+
"status": "tested"
|
|
44195
|
+
},
|
|
44097
44196
|
{
|
|
44098
44197
|
"id": "companies.unbilledWork",
|
|
44099
44198
|
"resource": "companies",
|
|
@@ -82195,8 +82294,8 @@
|
|
|
82195
82294
|
]
|
|
82196
82295
|
},
|
|
82197
82296
|
"operations": {
|
|
82198
|
-
"planHash": "
|
|
82199
|
-
"builtAt": "2026-11-
|
|
82297
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
82298
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
82200
82299
|
"records": [
|
|
82201
82300
|
{
|
|
82202
82301
|
"id": "operations.aggregate",
|
|
@@ -348,8 +348,8 @@ const CAPABILITY_DATA = {
|
|
|
348
348
|
],
|
|
349
349
|
"groups": {
|
|
350
350
|
"B": {
|
|
351
|
-
"planHash": "
|
|
352
|
-
"builtAt": "2026-11-
|
|
351
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
352
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
353
353
|
"records": [
|
|
354
354
|
{
|
|
355
355
|
"id": "appointments.count",
|
|
@@ -43132,8 +43132,8 @@ const CAPABILITY_DATA = {
|
|
|
43132
43132
|
]
|
|
43133
43133
|
},
|
|
43134
43134
|
"A": {
|
|
43135
|
-
"planHash": "
|
|
43136
|
-
"builtAt": "2026-11-
|
|
43135
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
43136
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
43137
43137
|
"records": [
|
|
43138
43138
|
{
|
|
43139
43139
|
"id": "companies.count",
|
|
@@ -44223,7 +44223,7 @@ const CAPABILITY_DATA = {
|
|
|
44223
44223
|
"metadata": {
|
|
44224
44224
|
"purpose": "Search company records by text (contains on the searchable fields).",
|
|
44225
44225
|
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: companyName only (contains); no vendor free-text search exists. limit defaults to 25, max 500. opts is a CLOSED bag (an unknown key is refused pre-request, zero wire — the valid keys: limit, includeFamily). includeFamily?: boolean (default false): each returned match gains a family block { parentID (the match's own parentCompanyID — zero extra wire: the field is on the returned row; null when absent), childIDs (ONE bounded single-page query per match — parentCompanyID eq, MaxRecords 50 — the vendor field casing; childIDsTruncated when that page came back full with a live next cursor — a short page or a full page with a null cursor is complete), blindNote (the plan-pinned blind-surface caveat: companies.query is unowned-blind — the family, and the search hits themselves, are scoped to the caller-visible enumeration — a family is reported as SEEN BY THIS API USER, never as complete) }. Wire cost: 1 (the search) + matches × 1 (the child queries) — with the default limit 25 that is <= 26 wire; lower limit for large candidate sets.",
|
|
44226
|
-
"preferredWhen": "
|
|
44226
|
+
"preferredWhen": "Substring names, abbreviations and family lookups. For typo tolerance use companies.searchFuzzy; exact matching remains companies.resolve.",
|
|
44227
44227
|
"related": [
|
|
44228
44228
|
"companies.resolve",
|
|
44229
44229
|
"companies.query"
|
|
@@ -44440,6 +44440,105 @@ const CAPABILITY_DATA = {
|
|
|
44440
44440
|
"compact": "CompanySummary",
|
|
44441
44441
|
"status": "tested"
|
|
44442
44442
|
},
|
|
44443
|
+
{
|
|
44444
|
+
"id": "companies.searchFuzzy",
|
|
44445
|
+
"resource": "companies",
|
|
44446
|
+
"udfCapable": true,
|
|
44447
|
+
"operation": "searchFuzzy",
|
|
44448
|
+
"kind": "helper",
|
|
44449
|
+
"endpoint": null,
|
|
44450
|
+
"effect": "read",
|
|
44451
|
+
"flags": [],
|
|
44452
|
+
"dryRun": false,
|
|
44453
|
+
"envelope": null,
|
|
44454
|
+
"inputSchema": {
|
|
44455
|
+
"query": {
|
|
44456
|
+
"type": "string",
|
|
44457
|
+
"required": true,
|
|
44458
|
+
"description": "Company name to match despite typos (at most 1000 characters and 16 distinct meaningful terms)."
|
|
44459
|
+
},
|
|
44460
|
+
"opts": {
|
|
44461
|
+
"type": "object",
|
|
44462
|
+
"required": false,
|
|
44463
|
+
"description": "CompanyFuzzySearchOptions — { limit?: number (1..10, default 10), includeFamily?: boolean, includeInactive?: boolean (default false) }. Returns { items: [{ record, distance, matchedTerms, coverage, source }], tier, truncated, pieces, index: { state, builtAt? } }; every row is a candidate to confirm.",
|
|
44464
|
+
"properties": [
|
|
44465
|
+
{
|
|
44466
|
+
"name": "limit",
|
|
44467
|
+
"type": "number",
|
|
44468
|
+
"optional": true,
|
|
44469
|
+
"default": 10
|
|
44470
|
+
},
|
|
44471
|
+
{
|
|
44472
|
+
"name": "includeFamily",
|
|
44473
|
+
"type": "boolean",
|
|
44474
|
+
"optional": true
|
|
44475
|
+
},
|
|
44476
|
+
{
|
|
44477
|
+
"name": "includeInactive",
|
|
44478
|
+
"type": "boolean",
|
|
44479
|
+
"optional": true,
|
|
44480
|
+
"default": false
|
|
44481
|
+
}
|
|
44482
|
+
]
|
|
44483
|
+
}
|
|
44484
|
+
},
|
|
44485
|
+
"inputSchemaStrict": true,
|
|
44486
|
+
"outputSchema": {
|
|
44487
|
+
"type": "CompanyFuzzySearchResult",
|
|
44488
|
+
"drops": []
|
|
44489
|
+
},
|
|
44490
|
+
"examples": [
|
|
44491
|
+
"await client.companies.searchFuzzy('example')"
|
|
44492
|
+
],
|
|
44493
|
+
"permissions": "unknown",
|
|
44494
|
+
"pagination": {
|
|
44495
|
+
"mode": "none"
|
|
44496
|
+
},
|
|
44497
|
+
"resolution": null,
|
|
44498
|
+
"retry": {
|
|
44499
|
+
"preset": "retry-ffb3a9cb"
|
|
44500
|
+
},
|
|
44501
|
+
"errors": {
|
|
44502
|
+
"set": 5
|
|
44503
|
+
},
|
|
44504
|
+
"metadata": {
|
|
44505
|
+
"purpose": "Find company candidates despite misspelt names; never infer an exact identity from a fuzzy candidate.",
|
|
44506
|
+
"usage": "Always performs one uncached live fragment query capped at 500 rows. The SDK lazily builds a separate slim company-name index in the background, refreshes it every 30 minutes and after company writes, and merges it with live results when warm. cache: false disables the index. Candidates are ranked by query-term coverage, Damerau edit distance (adjacent transposition counts as one), then active status. Active only unless includeInactive is true. Live fragments have bounded recall; inspect tier, truncated and index.state before interpreting a miss.",
|
|
44507
|
+
"preferredWhen": "A company name may contain typos. Use companies.resolve for exact identity and ask the caller to confirm fuzzy candidates.",
|
|
44508
|
+
"related": [
|
|
44509
|
+
"companies.resolve",
|
|
44510
|
+
"companies.search"
|
|
44511
|
+
],
|
|
44512
|
+
"untrustedFields": [
|
|
44513
|
+
"UDF1",
|
|
44514
|
+
"UDF10",
|
|
44515
|
+
"UDF11",
|
|
44516
|
+
"UDF12",
|
|
44517
|
+
"UDF13",
|
|
44518
|
+
"UDF14",
|
|
44519
|
+
"UDF15",
|
|
44520
|
+
"UDF16",
|
|
44521
|
+
"UDF17",
|
|
44522
|
+
"UDF18",
|
|
44523
|
+
"UDF19",
|
|
44524
|
+
"UDF2",
|
|
44525
|
+
"UDF20",
|
|
44526
|
+
"UDF3",
|
|
44527
|
+
"UDF4",
|
|
44528
|
+
"UDF5",
|
|
44529
|
+
"UDF6",
|
|
44530
|
+
"UDF7",
|
|
44531
|
+
"UDF8",
|
|
44532
|
+
"UDF9",
|
|
44533
|
+
"billToAttention",
|
|
44534
|
+
"companyName",
|
|
44535
|
+
"stockMarket",
|
|
44536
|
+
"stockSymbol"
|
|
44537
|
+
]
|
|
44538
|
+
},
|
|
44539
|
+
"compact": "CompanyFuzzySearchResult",
|
|
44540
|
+
"status": "tested"
|
|
44541
|
+
},
|
|
44443
44542
|
{
|
|
44444
44543
|
"id": "companies.unbilledWork",
|
|
44445
44544
|
"resource": "companies",
|
|
@@ -82541,8 +82640,8 @@ const CAPABILITY_DATA = {
|
|
|
82541
82640
|
]
|
|
82542
82641
|
},
|
|
82543
82642
|
"operations": {
|
|
82544
|
-
"planHash": "
|
|
82545
|
-
"builtAt": "2026-11-
|
|
82643
|
+
"planHash": "04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70",
|
|
82644
|
+
"builtAt": "2026-11-17T07:45:52.855Z",
|
|
82546
82645
|
"records": [
|
|
82547
82646
|
{
|
|
82548
82647
|
"id": "operations.aggregate",
|
package/dist/capabilities.cjs
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkSGH7F2CH_cjs = require('./chunk-SGH7F2CH.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 chunkSGH7F2CH_cjs.CAPABILITY_PLAN_HASHES; }
|
|
10
10
|
});
|
|
11
11
|
Object.defineProperty(exports, "loadCapabilities", {
|
|
12
12
|
enumerable: true,
|
|
13
|
-
get: function () { return
|
|
13
|
+
get: function () { return chunkSGH7F2CH_cjs.loadCapabilities; }
|
|
14
14
|
});
|
|
15
15
|
Object.defineProperty(exports, "loadCapabilityRecords", {
|
|
16
16
|
enumerable: true,
|
|
17
|
-
get: function () { return
|
|
17
|
+
get: function () { return chunkSGH7F2CH_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-JCMXQUIC.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-OUVUQQXH.js';
|
|
2
|
+
import { resolveConfig, HttpClient, SIMPLE_RESOURCES, GenericResource, CompaniesResource, ContractsResource, InvoicesResource, TimeEntriesResource, runWithSignal, AutotaskConfigError } from './chunk-DPJLN5BB.js';
|
|
3
3
|
|
|
4
4
|
// src/client.ts
|
|
5
5
|
var AutotaskClient = class {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
4
|
-
var
|
|
3
|
+
var chunkHFWOHUVF_cjs = require('./chunk-HFWOHUVF.cjs');
|
|
4
|
+
var chunkV2GE763R_cjs = require('./chunk-V2GE763R.cjs');
|
|
5
5
|
|
|
6
6
|
// src/client.ts
|
|
7
7
|
var AutotaskClient = class {
|
|
@@ -154,34 +154,34 @@ var AutotaskClient = class {
|
|
|
154
154
|
* anything is wired. Construction issues NO request.
|
|
155
155
|
*/
|
|
156
156
|
constructor(options) {
|
|
157
|
-
this.config =
|
|
158
|
-
this.http = new
|
|
157
|
+
this.config = chunkV2GE763R_cjs.resolveConfig(options);
|
|
158
|
+
this.http = new chunkV2GE763R_cjs.HttpClient(this.config);
|
|
159
159
|
this.http.client = this;
|
|
160
|
-
for (const entry of
|
|
161
|
-
this[entry.accessor] = new
|
|
160
|
+
for (const entry of chunkV2GE763R_cjs.SIMPLE_RESOURCES) {
|
|
161
|
+
this[entry.accessor] = new chunkV2GE763R_cjs.GenericResource(this.http, entry, this.config.pageSize);
|
|
162
162
|
}
|
|
163
|
-
this.companies = new
|
|
164
|
-
this.configurationItems = new
|
|
165
|
-
this.contacts = new
|
|
166
|
-
this.contracts = new
|
|
167
|
-
this.inventoryProducts = new
|
|
168
|
-
this.invoices = new
|
|
169
|
-
this.quotes = new
|
|
170
|
-
this.resourceTimeOffAdditional = new
|
|
171
|
-
this.resourceTimeOffBalances = new
|
|
172
|
-
this.resources = new
|
|
173
|
-
this.serviceCalls = new
|
|
174
|
-
this.ticketCharges = new
|
|
175
|
-
this.tickets = new
|
|
176
|
-
this.timeEntries = new
|
|
177
|
-
this.timeOffRequests = new
|
|
178
|
-
this.authenticateResource = new
|
|
179
|
-
this.entityInformation = new
|
|
180
|
-
this.modules = new
|
|
181
|
-
this.thresholdInformation = new
|
|
182
|
-
this.version = new
|
|
183
|
-
this.versionInformation = new
|
|
184
|
-
this.zoneInformation = new
|
|
163
|
+
this.companies = new chunkV2GE763R_cjs.CompaniesResource(this.http, this.config.pageSize);
|
|
164
|
+
this.configurationItems = new chunkHFWOHUVF_cjs.ConfigurationItemsResource(this.http, this.config.pageSize);
|
|
165
|
+
this.contacts = new chunkHFWOHUVF_cjs.ContactsResource(this.http, this.config.pageSize);
|
|
166
|
+
this.contracts = new chunkV2GE763R_cjs.ContractsResource(this.http, this.config.pageSize);
|
|
167
|
+
this.inventoryProducts = new chunkHFWOHUVF_cjs.InventoryProductsResource(this.http, this.config.pageSize);
|
|
168
|
+
this.invoices = new chunkV2GE763R_cjs.InvoicesResource(this.http, this.config.pageSize);
|
|
169
|
+
this.quotes = new chunkHFWOHUVF_cjs.QuotesResource(this.http, this.config.pageSize);
|
|
170
|
+
this.resourceTimeOffAdditional = new chunkHFWOHUVF_cjs.ResourceTimeOffAdditionalResource(this.http, this.config.pageSize);
|
|
171
|
+
this.resourceTimeOffBalances = new chunkHFWOHUVF_cjs.ResourceTimeOffBalancesResource(this.http, this.config.pageSize);
|
|
172
|
+
this.resources = new chunkHFWOHUVF_cjs.ResourcesResource(this.http, this.config, this.config.pageSize);
|
|
173
|
+
this.serviceCalls = new chunkHFWOHUVF_cjs.ServiceCallsResource(this.http, this.config.pageSize);
|
|
174
|
+
this.ticketCharges = new chunkHFWOHUVF_cjs.TicketChargesResource(this.http, this.config.pageSize);
|
|
175
|
+
this.tickets = new chunkHFWOHUVF_cjs.TicketsResource(this.http, this.config.pageSize);
|
|
176
|
+
this.timeEntries = new chunkV2GE763R_cjs.TimeEntriesResource(this.http, this.config.pageSize);
|
|
177
|
+
this.timeOffRequests = new chunkHFWOHUVF_cjs.TimeOffRequestsResource(this.http, this.config.pageSize);
|
|
178
|
+
this.authenticateResource = new chunkHFWOHUVF_cjs.AuthenticateResource(this.http);
|
|
179
|
+
this.entityInformation = new chunkHFWOHUVF_cjs.EntityInformationResource(this.http);
|
|
180
|
+
this.modules = new chunkHFWOHUVF_cjs.ModulesResource(this.http);
|
|
181
|
+
this.thresholdInformation = new chunkHFWOHUVF_cjs.ThresholdInformationResource(this.http);
|
|
182
|
+
this.version = new chunkHFWOHUVF_cjs.VersionResource(this.http);
|
|
183
|
+
this.versionInformation = new chunkHFWOHUVF_cjs.VersionInformationResource(this.http);
|
|
184
|
+
this.zoneInformation = new chunkHFWOHUVF_cjs.ZoneInformationResource(this.http);
|
|
185
185
|
}
|
|
186
186
|
/**
|
|
187
187
|
* `GET /V1.0/Authenticate` → `AuthTokenResultModel` (as-is). The SDK does
|
|
@@ -215,12 +215,12 @@ var AutotaskClient = class {
|
|
|
215
215
|
* parameter on each: `await client.withSignal(signal, () => invoke(client, ...))`.
|
|
216
216
|
*/
|
|
217
217
|
withSignal(signal, fn) {
|
|
218
|
-
return
|
|
218
|
+
return chunkV2GE763R_cjs.runWithSignal(signal, fn);
|
|
219
219
|
}
|
|
220
220
|
async batch(fn, items, opts = {}) {
|
|
221
221
|
const concurrency = opts.concurrency ?? this.config.maxConcurrent;
|
|
222
222
|
if (!Number.isInteger(concurrency) || concurrency <= 0) {
|
|
223
|
-
throw new
|
|
223
|
+
throw new chunkV2GE763R_cjs.AutotaskConfigError("batch concurrency must be a positive integer");
|
|
224
224
|
}
|
|
225
225
|
const { signal, settle } = opts;
|
|
226
226
|
const results = new Array(items.length);
|
|
@@ -235,7 +235,7 @@ var AutotaskClient = class {
|
|
|
235
235
|
const i = next++;
|
|
236
236
|
try {
|
|
237
237
|
const item = items[i];
|
|
238
|
-
const value = await (signal === void 0 ? fn(item) :
|
|
238
|
+
const value = await (signal === void 0 ? fn(item) : chunkV2GE763R_cjs.runWithSignal(signal, () => fn(item)));
|
|
239
239
|
results[i] = settle ? { status: "fulfilled", value } : value;
|
|
240
240
|
} catch (error) {
|
|
241
241
|
if (settle) results[i] = { status: "rejected", reason: error };
|