node-autotask 0.90.0 → 0.92.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/MCP_TOOL_CATALOG.json +360 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +2022 -655
  5. package/dist/capabilities-data.js +2021 -654
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-K5X4BPQC.js → chunk-2MC3LDZU.js} +3 -3
  9. package/dist/{chunk-4CI27SCM.cjs → chunk-ATDGRAX2.cjs} +33 -30
  10. package/dist/{chunk-HU6OGAPI.js → chunk-ELAU2MT5.js} +5 -2
  11. package/dist/{chunk-OI6E5XQA.cjs → chunk-H24SV774.cjs} +473 -122
  12. package/dist/{chunk-D7MJC7HA.cjs → chunk-JPZ7M7QI.cjs} +200 -200
  13. package/dist/{chunk-CY6USWUY.js → chunk-NQNAEA23.js} +468 -117
  14. package/dist/{chunk-ZLMYYO7R.cjs → chunk-QXJQIZCT.cjs} +3 -3
  15. package/dist/{chunk-Q73VQSUP.js → chunk-XAOWO42G.js} +2 -2
  16. package/dist/{index-4jmitXBs.d.cts → index-B9y5IwT1.d.cts} +115 -1
  17. package/dist/{index-4jmitXBs.d.ts → index-B9y5IwT1.d.ts} +115 -1
  18. package/dist/{index-DWyJAad_.d.ts → index-U7Lepdm2.d.ts} +10 -5
  19. package/dist/{index-BEqbDuMk.d.cts → index-lWek2NrV.d.cts} +10 -5
  20. package/dist/index.cjs +85 -85
  21. package/dist/index.d.cts +3 -3
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.js +5 -5
  24. package/dist/operations/index.cjs +51 -51
  25. package/dist/operations/index.d.cts +6 -4
  26. package/dist/operations/index.d.ts +6 -4
  27. package/dist/operations/index.js +2 -2
  28. package/dist/pool.cjs +12 -12
  29. package/dist/pool.d.cts +1 -1
  30. package/dist/pool.d.ts +1 -1
  31. package/dist/pool.js +4 -4
  32. package/dist/resources/index.cjs +27 -27
  33. package/dist/resources/index.d.cts +2 -2
  34. package/dist/resources/index.d.ts +2 -2
  35. package/dist/resources/index.js +3 -3
  36. package/dist/types/index.d.cts +1 -1
  37. package/dist/types/index.d.ts +1 -1
  38. package/docs/API.md +5 -2
  39. package/examples/mcp/manifest.ts +1 -1
  40. package/examples/mcp/tools-mode.ts +15 -6
  41. package/examples/mcp/tools-read.ts +8 -2
  42. package/package.json +1 -1
package/capabilities.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "generatedAt": "2026-11-21T03:40:52.155Z",
2
+ "generatedAt": "2026-11-21T07:49:35.542Z",
3
3
  "groups": {
4
4
  "B": {
5
- "planHash": "2f78ad6e25fd96f024dfc749c3c9d1b8dbf52d8a23e097bd5046605a9975787c",
6
- "builtAt": "2026-11-21T03:40:52.139Z",
5
+ "planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
6
+ "builtAt": "2026-11-21T07:49:35.531Z",
7
7
  "records": [
8
8
  {
9
9
  "id": "appointments.count",
@@ -16777,6 +16777,401 @@
16777
16777
  "compact": null,
16778
16778
  "status": "tested"
16779
16779
  },
16780
+ {
16781
+ "id": "internal_locations.count",
16782
+ "resource": "internal_locations",
16783
+ "udfCapable": false,
16784
+ "operation": "count",
16785
+ "kind": "primitive",
16786
+ "endpoint": "POST /V1.0/InternalLocations/query/count",
16787
+ "effect": "read",
16788
+ "flags": [],
16789
+ "dryRun": false,
16790
+ "envelope": "QueryCountResultModel",
16791
+ "inputSchema": {
16792
+ "params": {
16793
+ "type": "object",
16794
+ "required": false,
16795
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
16796
+ "properties": [
16797
+ {
16798
+ "name": "filter",
16799
+ "type": "FilterCondition[]",
16800
+ "optional": true
16801
+ },
16802
+ {
16803
+ "name": "fieldCheck",
16804
+ "type": "boolean",
16805
+ "optional": true
16806
+ }
16807
+ ]
16808
+ }
16809
+ },
16810
+ "inputSchemaStrict": true,
16811
+ "outputSchema": {
16812
+ "type": "QueryCountResultModel",
16813
+ "drops": []
16814
+ },
16815
+ "examples": [
16816
+ "await invoke(client, 'internal_locations.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
16817
+ ],
16818
+ "permissions": "unknown",
16819
+ "pagination": {
16820
+ "mode": "none"
16821
+ },
16822
+ "resolution": null,
16823
+ "retry": {
16824
+ "preset": "retry-ffb3a9cb"
16825
+ },
16826
+ "errors": {
16827
+ "set": 8
16828
+ },
16829
+ "metadata": {
16830
+ "purpose": "Count internal location records matching a JSON filter.",
16831
+ "usage": "Unwraps queryCount; returns a plain number. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
16832
+ "preferredWhen": null,
16833
+ "related": [
16834
+ "internal_locations.query"
16835
+ ],
16836
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
16837
+ "untrustedFields": [
16838
+ "additionalAddressInfo",
16839
+ "country",
16840
+ "name",
16841
+ "timeZone"
16842
+ ]
16843
+ },
16844
+ "compact": null,
16845
+ "status": "tested"
16846
+ },
16847
+ {
16848
+ "id": "internal_locations.get",
16849
+ "resource": "internal_locations",
16850
+ "udfCapable": false,
16851
+ "operation": "get",
16852
+ "kind": "primitive",
16853
+ "endpoint": "GET /V1.0/InternalLocations/{id}",
16854
+ "effect": "read",
16855
+ "flags": [],
16856
+ "dryRun": false,
16857
+ "envelope": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
16858
+ "inputSchema": {
16859
+ "id": {
16860
+ "type": "string | number",
16861
+ "required": true,
16862
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
16863
+ },
16864
+ "opts": {
16865
+ "type": "object",
16866
+ "required": false,
16867
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
16868
+ "properties": [
16869
+ {
16870
+ "name": "fresh",
16871
+ "type": "boolean",
16872
+ "optional": true
16873
+ }
16874
+ ]
16875
+ }
16876
+ },
16877
+ "inputSchemaStrict": true,
16878
+ "outputSchema": {
16879
+ "type": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
16880
+ "drops": []
16881
+ },
16882
+ "examples": [
16883
+ "await invoke(client, 'internal_locations.get', [3])"
16884
+ ],
16885
+ "permissions": "unknown",
16886
+ "pagination": {
16887
+ "mode": "none"
16888
+ },
16889
+ "resolution": null,
16890
+ "retry": {
16891
+ "preset": "retry-ffb3a9cb"
16892
+ },
16893
+ "errors": {
16894
+ "set": 3
16895
+ },
16896
+ "metadata": {
16897
+ "purpose": "Get one InternalLocation by id.",
16898
+ "usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
16899
+ "preferredWhen": "Use a known internal location id; use internal_locations.query for bounded discovery.",
16900
+ "related": [
16901
+ "internal_locations.query"
16902
+ ],
16903
+ "args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an internal_locations.query with includeFields.",
16904
+ "untrustedFields": [
16905
+ "additionalAddressInfo",
16906
+ "country",
16907
+ "name",
16908
+ "timeZone"
16909
+ ]
16910
+ },
16911
+ "compact": null,
16912
+ "status": "tested"
16913
+ },
16914
+ {
16915
+ "id": "internal_locations.getEntityInfo",
16916
+ "resource": "internal_locations",
16917
+ "udfCapable": false,
16918
+ "operation": "getEntityInfo",
16919
+ "kind": "primitive",
16920
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation",
16921
+ "effect": "read",
16922
+ "flags": [],
16923
+ "dryRun": false,
16924
+ "envelope": "EntityInformationResultModel",
16925
+ "inputSchema": {},
16926
+ "inputSchemaStrict": true,
16927
+ "outputSchema": {
16928
+ "type": "EntityInformationResultModel",
16929
+ "drops": []
16930
+ },
16931
+ "examples": [
16932
+ "await client.internalLocations.getEntityInfo()"
16933
+ ],
16934
+ "permissions": "unknown",
16935
+ "pagination": {
16936
+ "mode": "none"
16937
+ },
16938
+ "resolution": null,
16939
+ "retry": {
16940
+ "preset": "retry-ffb3a9cb"
16941
+ },
16942
+ "errors": {
16943
+ "set": 8
16944
+ },
16945
+ "metadata": {
16946
+ "purpose": "Get the InternalLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
16947
+ "usage": "Unwraps info{}; drives client-side capability checks. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
16948
+ "preferredWhen": null,
16949
+ "related": [
16950
+ "internal_locations.getFieldInfo"
16951
+ ],
16952
+ "untrustedFields": [
16953
+ "additionalAddressInfo",
16954
+ "country",
16955
+ "name",
16956
+ "timeZone"
16957
+ ]
16958
+ },
16959
+ "compact": null,
16960
+ "status": "tested"
16961
+ },
16962
+ {
16963
+ "id": "internal_locations.getFieldInfo",
16964
+ "resource": "internal_locations",
16965
+ "udfCapable": false,
16966
+ "operation": "getFieldInfo",
16967
+ "kind": "primitive",
16968
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation/fields",
16969
+ "effect": "read",
16970
+ "flags": [],
16971
+ "dryRun": false,
16972
+ "envelope": "FieldInformationResultModel",
16973
+ "inputSchema": {},
16974
+ "inputSchemaStrict": true,
16975
+ "outputSchema": {
16976
+ "type": "FieldInformationResultModel",
16977
+ "drops": []
16978
+ },
16979
+ "examples": [
16980
+ "await client.internalLocations.getFieldInfo()"
16981
+ ],
16982
+ "permissions": "unknown",
16983
+ "pagination": {
16984
+ "mode": "none"
16985
+ },
16986
+ "resolution": null,
16987
+ "retry": {
16988
+ "preset": "retry-ffb3a9cb"
16989
+ },
16990
+ "errors": {
16991
+ "set": 8
16992
+ },
16993
+ "metadata": {
16994
+ "purpose": "Get the InternalLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
16995
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
16996
+ "preferredWhen": "Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
16997
+ "related": [
16998
+ "internal_locations.getEntityInfo",
16999
+ "internal_locations.getUdfInfo"
17000
+ ],
17001
+ "untrustedFields": [
17002
+ "additionalAddressInfo",
17003
+ "country",
17004
+ "name",
17005
+ "timeZone"
17006
+ ]
17007
+ },
17008
+ "compact": null,
17009
+ "status": "tested"
17010
+ },
17011
+ {
17012
+ "id": "internal_locations.getUdfInfo",
17013
+ "resource": "internal_locations",
17014
+ "udfCapable": false,
17015
+ "operation": "getUdfInfo",
17016
+ "kind": "primitive",
17017
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation/userDefinedFields",
17018
+ "effect": "read",
17019
+ "flags": [],
17020
+ "dryRun": false,
17021
+ "envelope": "UserDefinedFieldInformationResultModel",
17022
+ "inputSchema": {},
17023
+ "inputSchemaStrict": true,
17024
+ "outputSchema": {
17025
+ "type": "UserDefinedFieldInformationResultModel",
17026
+ "drops": []
17027
+ },
17028
+ "examples": [
17029
+ "await client.internalLocations.getUdfInfo()"
17030
+ ],
17031
+ "permissions": "unknown",
17032
+ "pagination": {
17033
+ "mode": "none"
17034
+ },
17035
+ "resolution": null,
17036
+ "retry": {
17037
+ "preset": "retry-ffb3a9cb"
17038
+ },
17039
+ "errors": {
17040
+ "set": 8
17041
+ },
17042
+ "metadata": {
17043
+ "purpose": "Get the InternalLocation user-defined-field catalog.",
17044
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17045
+ "preferredWhen": null,
17046
+ "related": [
17047
+ "internal_locations.getFieldInfo"
17048
+ ],
17049
+ "untrustedFields": [
17050
+ "additionalAddressInfo",
17051
+ "country",
17052
+ "name",
17053
+ "timeZone"
17054
+ ]
17055
+ },
17056
+ "compact": null,
17057
+ "status": "tested"
17058
+ },
17059
+ {
17060
+ "id": "internal_locations.query",
17061
+ "resource": "internal_locations",
17062
+ "udfCapable": false,
17063
+ "operation": "query",
17064
+ "kind": "primitive",
17065
+ "endpoint": "GET|POST /V1.0/InternalLocations/query",
17066
+ "effect": "read",
17067
+ "flags": [],
17068
+ "dryRun": false,
17069
+ "envelope": "QueryActionResult[InternalLocationModel,InternalLocation]",
17070
+ "inputSchema": {
17071
+ "params": {
17072
+ "type": "object",
17073
+ "required": false,
17074
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
17075
+ "properties": [
17076
+ {
17077
+ "name": "filter",
17078
+ "type": "FilterCondition[]",
17079
+ "optional": true
17080
+ },
17081
+ {
17082
+ "name": "limit",
17083
+ "type": "number",
17084
+ "optional": true,
17085
+ "default": 500
17086
+ },
17087
+ {
17088
+ "name": "latest",
17089
+ "type": "number",
17090
+ "optional": true
17091
+ },
17092
+ {
17093
+ "name": "noteChars",
17094
+ "type": "number",
17095
+ "optional": true
17096
+ },
17097
+ {
17098
+ "name": "includeFields",
17099
+ "type": "string[]",
17100
+ "optional": true
17101
+ },
17102
+ {
17103
+ "name": "fieldCheck",
17104
+ "type": "boolean",
17105
+ "optional": true,
17106
+ "default": true
17107
+ },
17108
+ {
17109
+ "name": "names",
17110
+ "type": "boolean",
17111
+ "optional": true
17112
+ },
17113
+ {
17114
+ "name": "via",
17115
+ "type": "\"post\" | \"get\"",
17116
+ "optional": true
17117
+ },
17118
+ {
17119
+ "name": "acknowledgeUnscoped",
17120
+ "type": "boolean",
17121
+ "optional": true
17122
+ },
17123
+ {
17124
+ "name": "walk",
17125
+ "type": "object",
17126
+ "optional": true
17127
+ }
17128
+ ]
17129
+ }
17130
+ },
17131
+ "inputSchemaStrict": true,
17132
+ "outputSchema": {
17133
+ "type": "QueryActionResult[InternalLocationModel,InternalLocation]",
17134
+ "drops": []
17135
+ },
17136
+ "examples": [
17137
+ "await invoke(client, 'internal_locations.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
17138
+ ],
17139
+ "permissions": "unknown",
17140
+ "pagination": {
17141
+ "mode": "cursor",
17142
+ "vendorDefault": 10,
17143
+ "vendorMax": 500,
17144
+ "pageGuard": 1000,
17145
+ "queryBounded": {
17146
+ "default": 500,
17147
+ "max": 2500
17148
+ }
17149
+ },
17150
+ "resolution": null,
17151
+ "retry": {
17152
+ "preset": "retry-ffb3a9cb"
17153
+ },
17154
+ "errors": {
17155
+ "set": 9
17156
+ },
17157
+ "metadata": {
17158
+ "purpose": "Query InternalLocation records with a JSON filter.",
17159
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17160
+ "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).",
17161
+ "related": [
17162
+ "internal_locations.get"
17163
+ ],
17164
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
17165
+ "untrustedFields": [
17166
+ "additionalAddressInfo",
17167
+ "country",
17168
+ "name",
17169
+ "timeZone"
17170
+ ]
17171
+ },
17172
+ "compact": null,
17173
+ "status": "tested"
17174
+ },
16780
17175
  {
16781
17176
  "id": "inventory_products.count",
16782
17177
  "resource": "inventory_products",
@@ -18140,7 +18535,7 @@
18140
18535
  "preset": "retry-1849870d"
18141
18536
  },
18142
18537
  "errors": {
18143
- "set": 8
18538
+ "set": 10
18144
18539
  },
18145
18540
  "metadata": {
18146
18541
  "purpose": "delete article root records.",
@@ -29640,7 +30035,7 @@
29640
30035
  "preset": "retry-ffb3a9cb"
29641
30036
  },
29642
30037
  "errors": {
29643
- "set": 9
30038
+ "set": 11
29644
30039
  },
29645
30040
  "metadata": {
29646
30041
  "purpose": "Get a resource's workload in a single call: its open tickets (rows + the exact open totals), its task assignments and the tasks behind them, its time-off balances and requests.",
@@ -33846,7 +34241,7 @@
33846
34241
  "preset": "retry-ffb3a9cb"
33847
34242
  },
33848
34243
  "errors": {
33849
- "set": 10
34244
+ "set": 12
33850
34245
  },
33851
34246
  "metadata": {
33852
34247
  "purpose": "Get a service call with its tickets, tasks and resource assignments in a single call — the assignment join runs through the call's task row ids (serviceCallTaskID).",
@@ -35609,12 +36004,12 @@
35609
36004
  "status": "tested"
35610
36005
  },
35611
36006
  {
35612
- "id": "skills.count",
35613
- "resource": "skills",
36007
+ "id": "shipping_types.count",
36008
+ "resource": "shipping_types",
35614
36009
  "udfCapable": false,
35615
36010
  "operation": "count",
35616
36011
  "kind": "primitive",
35617
- "endpoint": "GET|POST /V1.0/Skills/query/count",
36012
+ "endpoint": "POST /V1.0/ShippingTypes/query/count",
35618
36013
  "effect": "read",
35619
36014
  "flags": [],
35620
36015
  "dryRun": false,
@@ -35644,7 +36039,7 @@
35644
36039
  "drops": []
35645
36040
  },
35646
36041
  "examples": [
35647
- "await client.skills.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
36042
+ "await invoke(client, 'shipping_types.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
35648
36043
  ],
35649
36044
  "permissions": "unknown",
35650
36045
  "pagination": {
@@ -35655,14 +36050,14 @@
35655
36050
  "preset": "retry-ffb3a9cb"
35656
36051
  },
35657
36052
  "errors": {
35658
- "set": 0
36053
+ "set": 8
35659
36054
  },
35660
36055
  "metadata": {
35661
- "purpose": "Count skill records matching a JSON filter.",
35662
- "usage": "Unwraps queryCount; returns a plain number.",
36056
+ "purpose": "Count shipping type records matching a JSON filter.",
36057
+ "usage": "Unwraps queryCount; returns a plain number. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
35663
36058
  "preferredWhen": null,
35664
36059
  "related": [
35665
- "skills.query"
36060
+ "shipping_types.query"
35666
36061
  ],
35667
36062
  "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
35668
36063
  "untrustedFields": [
@@ -35674,16 +36069,16 @@
35674
36069
  "status": "tested"
35675
36070
  },
35676
36071
  {
35677
- "id": "skills.get",
35678
- "resource": "skills",
36072
+ "id": "shipping_types.get",
36073
+ "resource": "shipping_types",
35679
36074
  "udfCapable": false,
35680
36075
  "operation": "get",
35681
36076
  "kind": "primitive",
35682
- "endpoint": "GET /V1.0/Skills/{id}",
36077
+ "endpoint": "GET /V1.0/ShippingTypes/{id}",
35683
36078
  "effect": "read",
35684
36079
  "flags": [],
35685
36080
  "dryRun": false,
35686
- "envelope": "ItemQueryResultModel[SkillModel,Skill]",
36081
+ "envelope": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
35687
36082
  "inputSchema": {
35688
36083
  "id": {
35689
36084
  "type": "string | number",
@@ -35705,11 +36100,11 @@
35705
36100
  },
35706
36101
  "inputSchemaStrict": true,
35707
36102
  "outputSchema": {
35708
- "type": "ItemQueryResultModel[SkillModel,Skill]",
36103
+ "type": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
35709
36104
  "drops": []
35710
36105
  },
35711
36106
  "examples": [
35712
- "await client.skills.get('example-value')"
36107
+ "await invoke(client, 'shipping_types.get', [3])"
35713
36108
  ],
35714
36109
  "permissions": "unknown",
35715
36110
  "pagination": {
@@ -35723,13 +36118,13 @@
35723
36118
  "set": 3
35724
36119
  },
35725
36120
  "metadata": {
35726
- "purpose": "Get one Skill by id.",
35727
- "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
35728
- "preferredWhen": "Preferred when the numeric id is already known; skills.resolve is for a field value.",
36121
+ "purpose": "Get one ShippingType by id.",
36122
+ "usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36123
+ "preferredWhen": "Use a known shipping type id; use shipping_types.query for bounded discovery.",
35729
36124
  "related": [
35730
- "skills.resolve"
36125
+ "shipping_types.query"
35731
36126
  ],
35732
- "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use skills.search (compact summary) or a skills.query with includeFields.",
36127
+ "args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a shipping_types.query with includeFields.",
35733
36128
  "untrustedFields": [
35734
36129
  "description",
35735
36130
  "name"
@@ -35739,12 +36134,12 @@
35739
36134
  "status": "tested"
35740
36135
  },
35741
36136
  {
35742
- "id": "skills.getEntityInfo",
35743
- "resource": "skills",
36137
+ "id": "shipping_types.getEntityInfo",
36138
+ "resource": "shipping_types",
35744
36139
  "udfCapable": false,
35745
36140
  "operation": "getEntityInfo",
35746
36141
  "kind": "primitive",
35747
- "endpoint": "GET /V1.0/Skills/entityInformation",
36142
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation",
35748
36143
  "effect": "read",
35749
36144
  "flags": [],
35750
36145
  "dryRun": false,
@@ -35756,7 +36151,7 @@
35756
36151
  "drops": []
35757
36152
  },
35758
36153
  "examples": [
35759
- "await client.skills.getEntityInfo()"
36154
+ "await client.shippingTypes.getEntityInfo()"
35760
36155
  ],
35761
36156
  "permissions": "unknown",
35762
36157
  "pagination": {
@@ -35767,14 +36162,14 @@
35767
36162
  "preset": "retry-ffb3a9cb"
35768
36163
  },
35769
36164
  "errors": {
35770
- "set": 0
36165
+ "set": 8
35771
36166
  },
35772
36167
  "metadata": {
35773
- "purpose": "Get the Skill capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
35774
- "usage": "Unwraps info{}; drives client-side capability checks.",
36168
+ "purpose": "Get the ShippingType capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
36169
+ "usage": "Unwraps info{}; drives client-side capability checks. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
35775
36170
  "preferredWhen": null,
35776
36171
  "related": [
35777
- "skills.getFieldInfo"
36172
+ "shipping_types.getFieldInfo"
35778
36173
  ],
35779
36174
  "untrustedFields": [
35780
36175
  "description",
@@ -35785,12 +36180,12 @@
35785
36180
  "status": "tested"
35786
36181
  },
35787
36182
  {
35788
- "id": "skills.getFieldInfo",
35789
- "resource": "skills",
36183
+ "id": "shipping_types.getFieldInfo",
36184
+ "resource": "shipping_types",
35790
36185
  "udfCapable": false,
35791
36186
  "operation": "getFieldInfo",
35792
36187
  "kind": "primitive",
35793
- "endpoint": "GET /V1.0/Skills/entityInformation/fields",
36188
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation/fields",
35794
36189
  "effect": "read",
35795
36190
  "flags": [],
35796
36191
  "dryRun": false,
@@ -35802,7 +36197,7 @@
35802
36197
  "drops": []
35803
36198
  },
35804
36199
  "examples": [
35805
- "await client.skills.getFieldInfo()"
36200
+ "await client.shippingTypes.getFieldInfo()"
35806
36201
  ],
35807
36202
  "permissions": "unknown",
35808
36203
  "pagination": {
@@ -35813,15 +36208,15 @@
35813
36208
  "preset": "retry-ffb3a9cb"
35814
36209
  },
35815
36210
  "errors": {
35816
- "set": 0
36211
+ "set": 8
35817
36212
  },
35818
36213
  "metadata": {
35819
- "purpose": "Get the Skill field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
36214
+ "purpose": "Get the ShippingType field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
35820
36215
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
35821
- "preferredWhen": null,
36216
+ "preferredWhen": "Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
35822
36217
  "related": [
35823
- "skills.getEntityInfo",
35824
- "skills.getUdfInfo"
36218
+ "shipping_types.getEntityInfo",
36219
+ "shipping_types.getUdfInfo"
35825
36220
  ],
35826
36221
  "untrustedFields": [
35827
36222
  "description",
@@ -35832,12 +36227,12 @@
35832
36227
  "status": "tested"
35833
36228
  },
35834
36229
  {
35835
- "id": "skills.getUdfInfo",
35836
- "resource": "skills",
36230
+ "id": "shipping_types.getUdfInfo",
36231
+ "resource": "shipping_types",
35837
36232
  "udfCapable": false,
35838
36233
  "operation": "getUdfInfo",
35839
36234
  "kind": "primitive",
35840
- "endpoint": "GET /V1.0/Skills/entityInformation/userDefinedFields",
36235
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation/userDefinedFields",
35841
36236
  "effect": "read",
35842
36237
  "flags": [],
35843
36238
  "dryRun": false,
@@ -35849,7 +36244,7 @@
35849
36244
  "drops": []
35850
36245
  },
35851
36246
  "examples": [
35852
- "await client.skills.getUdfInfo()"
36247
+ "await client.shippingTypes.getUdfInfo()"
35853
36248
  ],
35854
36249
  "permissions": "unknown",
35855
36250
  "pagination": {
@@ -35860,14 +36255,14 @@
35860
36255
  "preset": "retry-ffb3a9cb"
35861
36256
  },
35862
36257
  "errors": {
35863
- "set": 0
36258
+ "set": 8
35864
36259
  },
35865
36260
  "metadata": {
35866
- "purpose": "Get the Skill user-defined-field catalog.",
35867
- "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
36261
+ "purpose": "Get the ShippingType user-defined-field catalog.",
36262
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
35868
36263
  "preferredWhen": null,
35869
36264
  "related": [
35870
- "skills.getFieldInfo"
36265
+ "shipping_types.getFieldInfo"
35871
36266
  ],
35872
36267
  "untrustedFields": [
35873
36268
  "description",
@@ -35878,16 +36273,16 @@
35878
36273
  "status": "tested"
35879
36274
  },
35880
36275
  {
35881
- "id": "skills.query",
35882
- "resource": "skills",
36276
+ "id": "shipping_types.query",
36277
+ "resource": "shipping_types",
35883
36278
  "udfCapable": false,
35884
36279
  "operation": "query",
35885
36280
  "kind": "primitive",
35886
- "endpoint": "GET|POST /V1.0/Skills/query",
36281
+ "endpoint": "GET|POST /V1.0/ShippingTypes/query",
35887
36282
  "effect": "read",
35888
36283
  "flags": [],
35889
36284
  "dryRun": false,
35890
- "envelope": "QueryActionResult[<Model>,<Entity>]",
36285
+ "envelope": "QueryActionResult[ShippingTypeModel,ShippingType]",
35891
36286
  "inputSchema": {
35892
36287
  "params": {
35893
36288
  "type": "object",
@@ -35951,11 +36346,11 @@
35951
36346
  },
35952
36347
  "inputSchemaStrict": true,
35953
36348
  "outputSchema": {
35954
- "type": "QueryActionResult[<Model>,<Entity>]",
36349
+ "type": "QueryActionResult[ShippingTypeModel,ShippingType]",
35955
36350
  "drops": []
35956
36351
  },
35957
36352
  "examples": [
35958
- "await client.skills.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
36353
+ "await invoke(client, 'shipping_types.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
35959
36354
  ],
35960
36355
  "permissions": "unknown",
35961
36356
  "pagination": {
@@ -35973,16 +36368,16 @@
35973
36368
  "preset": "retry-ffb3a9cb"
35974
36369
  },
35975
36370
  "errors": {
35976
- "set": 4
36371
+ "set": 9
35977
36372
  },
35978
36373
  "metadata": {
35979
- "purpose": "Query Skill records with a JSON filter.",
35980
- "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
36374
+ "purpose": "Query ShippingType records with a JSON filter.",
36375
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
35981
36376
  "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).",
35982
36377
  "related": [
35983
- "skills.resolve"
36378
+ "shipping_types.get"
35984
36379
  ],
35985
- "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer skills.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
36380
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
35986
36381
  "untrustedFields": [
35987
36382
  "description",
35988
36383
  "name"
@@ -35992,149 +36387,12 @@
35992
36387
  "status": "tested"
35993
36388
  },
35994
36389
  {
35995
- "id": "skills.resolve",
35996
- "resource": "skills",
35997
- "udfCapable": false,
35998
- "operation": "resolve",
35999
- "kind": "helper",
36000
- "endpoint": null,
36001
- "effect": "read",
36002
- "flags": [],
36003
- "dryRun": false,
36004
- "envelope": null,
36005
- "inputSchema": {
36006
- "identifier": {
36007
- "type": "string | number",
36008
- "required": true,
36009
- "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
36010
- },
36011
- "opts": {
36012
- "type": "object",
36013
- "required": false,
36014
- "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
36015
- "properties": [
36016
- {
36017
- "name": "expand",
36018
- "type": "boolean",
36019
- "optional": true
36020
- }
36021
- ]
36022
- }
36023
- },
36024
- "inputSchemaStrict": true,
36025
- "outputSchema": {
36026
- "type": "SkillSummary",
36027
- "drops": []
36028
- },
36029
- "examples": [
36030
- "await client.skills.resolve('example-value')"
36031
- ],
36032
- "permissions": "unknown",
36033
- "pagination": {
36034
- "mode": "none"
36035
- },
36036
- "resolution": {
36037
- "basis": "server-filter",
36038
- "maxScanRecords": 500,
36039
- "maxScanPages": 4
36040
- },
36041
- "retry": {
36042
- "preset": "retry-ffb3a9cb"
36043
- },
36044
- "errors": {
36045
- "set": 5
36046
- },
36047
- "metadata": {
36048
- "purpose": "Resolve a skill from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Skill record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
36049
- "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
36050
- "preferredWhen": null,
36051
- "related": [
36052
- "skills.get"
36053
- ],
36054
- "untrustedFields": [
36055
- "description",
36056
- "name"
36057
- ]
36058
- },
36059
- "compact": "SkillSummary",
36060
- "status": "tested"
36061
- },
36062
- {
36063
- "id": "skills.search",
36390
+ "id": "skills.count",
36064
36391
  "resource": "skills",
36065
36392
  "udfCapable": false,
36066
- "operation": "search",
36067
- "kind": "helper",
36068
- "endpoint": null,
36069
- "effect": "read",
36070
- "flags": [],
36071
- "dryRun": false,
36072
- "envelope": null,
36073
- "inputSchema": {
36074
- "query": {
36075
- "type": "string",
36076
- "required": true,
36077
- "description": "The free text to match (contains) on the resource searchable fields."
36078
- },
36079
- "opts": {
36080
- "type": "object",
36081
- "required": false,
36082
- "description": "SearchOpts — { limit?: number } (1-500, default 25).",
36083
- "properties": [
36084
- {
36085
- "name": "limit",
36086
- "type": "number",
36087
- "optional": true
36088
- }
36089
- ]
36090
- }
36091
- },
36092
- "inputSchemaStrict": true,
36093
- "outputSchema": {
36094
- "type": "SkillSummary",
36095
- "drops": []
36096
- },
36097
- "examples": [
36098
- "await client.skills.search('example')"
36099
- ],
36100
- "permissions": "unknown",
36101
- "pagination": {
36102
- "mode": "none"
36103
- },
36104
- "resolution": {
36105
- "basis": "server-filter",
36106
- "maxScanRecords": 500,
36107
- "maxScanPages": 4
36108
- },
36109
- "retry": {
36110
- "preset": "retry-ffb3a9cb"
36111
- },
36112
- "errors": {
36113
- "set": 5
36114
- },
36115
- "metadata": {
36116
- "purpose": "Search skill records by text (contains on the searchable fields).",
36117
- "usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
36118
- "preferredWhen": null,
36119
- "related": [
36120
- "skills.resolve",
36121
- "skills.query"
36122
- ],
36123
- "untrustedFields": [
36124
- "description",
36125
- "name"
36126
- ]
36127
- },
36128
- "compact": "SkillSummary",
36129
- "status": "tested"
36130
- },
36131
- {
36132
- "id": "subscription_periods.count",
36133
- "resource": "subscription_periods",
36134
- "udfCapable": false,
36135
36393
  "operation": "count",
36136
36394
  "kind": "primitive",
36137
- "endpoint": "GET|POST /V1.0/SubscriptionPeriods/query/count",
36395
+ "endpoint": "GET|POST /V1.0/Skills/query/count",
36138
36396
  "effect": "read",
36139
36397
  "flags": [],
36140
36398
  "dryRun": false,
@@ -36164,7 +36422,7 @@
36164
36422
  "drops": []
36165
36423
  },
36166
36424
  "examples": [
36167
- "await client.subscriptionPeriods.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
36425
+ "await client.skills.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
36168
36426
  ],
36169
36427
  "permissions": "unknown",
36170
36428
  "pagination": {
@@ -36178,28 +36436,32 @@
36178
36436
  "set": 0
36179
36437
  },
36180
36438
  "metadata": {
36181
- "purpose": "Count subscription period records matching a JSON filter.",
36439
+ "purpose": "Count skill records matching a JSON filter.",
36182
36440
  "usage": "Unwraps queryCount; returns a plain number.",
36183
36441
  "preferredWhen": null,
36184
36442
  "related": [
36185
- "subscription_periods.query"
36443
+ "skills.query"
36186
36444
  ],
36187
- "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars."
36445
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
36446
+ "untrustedFields": [
36447
+ "description",
36448
+ "name"
36449
+ ]
36188
36450
  },
36189
36451
  "compact": null,
36190
36452
  "status": "tested"
36191
36453
  },
36192
36454
  {
36193
- "id": "subscription_periods.get",
36194
- "resource": "subscription_periods",
36455
+ "id": "skills.get",
36456
+ "resource": "skills",
36195
36457
  "udfCapable": false,
36196
36458
  "operation": "get",
36197
36459
  "kind": "primitive",
36198
- "endpoint": "GET /V1.0/SubscriptionPeriods/{id}",
36460
+ "endpoint": "GET /V1.0/Skills/{id}",
36199
36461
  "effect": "read",
36200
36462
  "flags": [],
36201
36463
  "dryRun": false,
36202
- "envelope": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
36464
+ "envelope": "ItemQueryResultModel[SkillModel,Skill]",
36203
36465
  "inputSchema": {
36204
36466
  "id": {
36205
36467
  "type": "string | number",
@@ -36221,11 +36483,11 @@
36221
36483
  },
36222
36484
  "inputSchemaStrict": true,
36223
36485
  "outputSchema": {
36224
- "type": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
36486
+ "type": "ItemQueryResultModel[SkillModel,Skill]",
36225
36487
  "drops": []
36226
36488
  },
36227
36489
  "examples": [
36228
- "await client.subscriptionPeriods.get('example-value')"
36490
+ "await client.skills.get('example-value')"
36229
36491
  ],
36230
36492
  "permissions": "unknown",
36231
36493
  "pagination": {
@@ -36239,24 +36501,28 @@
36239
36501
  "set": 3
36240
36502
  },
36241
36503
  "metadata": {
36242
- "purpose": "Get one SubscriptionPeriod by id.",
36504
+ "purpose": "Get one Skill by id.",
36243
36505
  "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
36244
- "preferredWhen": "Preferred when the numeric id is already known; subscription_periods.resolve is for a field value.",
36506
+ "preferredWhen": "Preferred when the numeric id is already known; skills.resolve is for a field value.",
36245
36507
  "related": [
36246
- "subscription_periods.resolve"
36508
+ "skills.resolve"
36247
36509
  ],
36248
- "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a subscription_periods.query with includeFields."
36510
+ "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use skills.search (compact summary) or a skills.query with includeFields.",
36511
+ "untrustedFields": [
36512
+ "description",
36513
+ "name"
36514
+ ]
36249
36515
  },
36250
36516
  "compact": null,
36251
36517
  "status": "tested"
36252
36518
  },
36253
36519
  {
36254
- "id": "subscription_periods.getEntityInfo",
36255
- "resource": "subscription_periods",
36520
+ "id": "skills.getEntityInfo",
36521
+ "resource": "skills",
36256
36522
  "udfCapable": false,
36257
36523
  "operation": "getEntityInfo",
36258
36524
  "kind": "primitive",
36259
- "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation",
36525
+ "endpoint": "GET /V1.0/Skills/entityInformation",
36260
36526
  "effect": "read",
36261
36527
  "flags": [],
36262
36528
  "dryRun": false,
@@ -36268,7 +36534,7 @@
36268
36534
  "drops": []
36269
36535
  },
36270
36536
  "examples": [
36271
- "await client.subscriptionPeriods.getEntityInfo()"
36537
+ "await client.skills.getEntityInfo()"
36272
36538
  ],
36273
36539
  "permissions": "unknown",
36274
36540
  "pagination": {
@@ -36282,23 +36548,27 @@
36282
36548
  "set": 0
36283
36549
  },
36284
36550
  "metadata": {
36285
- "purpose": "Get the SubscriptionPeriod capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
36551
+ "purpose": "Get the Skill capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
36286
36552
  "usage": "Unwraps info{}; drives client-side capability checks.",
36287
36553
  "preferredWhen": null,
36288
36554
  "related": [
36289
- "subscription_periods.getFieldInfo"
36555
+ "skills.getFieldInfo"
36556
+ ],
36557
+ "untrustedFields": [
36558
+ "description",
36559
+ "name"
36290
36560
  ]
36291
36561
  },
36292
36562
  "compact": null,
36293
36563
  "status": "tested"
36294
36564
  },
36295
36565
  {
36296
- "id": "subscription_periods.getFieldInfo",
36297
- "resource": "subscription_periods",
36566
+ "id": "skills.getFieldInfo",
36567
+ "resource": "skills",
36298
36568
  "udfCapable": false,
36299
36569
  "operation": "getFieldInfo",
36300
36570
  "kind": "primitive",
36301
- "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/fields",
36571
+ "endpoint": "GET /V1.0/Skills/entityInformation/fields",
36302
36572
  "effect": "read",
36303
36573
  "flags": [],
36304
36574
  "dryRun": false,
@@ -36310,7 +36580,7 @@
36310
36580
  "drops": []
36311
36581
  },
36312
36582
  "examples": [
36313
- "await client.subscriptionPeriods.getFieldInfo()"
36583
+ "await client.skills.getFieldInfo()"
36314
36584
  ],
36315
36585
  "permissions": "unknown",
36316
36586
  "pagination": {
@@ -36324,24 +36594,28 @@
36324
36594
  "set": 0
36325
36595
  },
36326
36596
  "metadata": {
36327
- "purpose": "Get the SubscriptionPeriod field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
36597
+ "purpose": "Get the Skill field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
36328
36598
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
36329
36599
  "preferredWhen": null,
36330
36600
  "related": [
36331
- "subscription_periods.getEntityInfo",
36332
- "subscription_periods.getUdfInfo"
36601
+ "skills.getEntityInfo",
36602
+ "skills.getUdfInfo"
36603
+ ],
36604
+ "untrustedFields": [
36605
+ "description",
36606
+ "name"
36333
36607
  ]
36334
36608
  },
36335
36609
  "compact": null,
36336
36610
  "status": "tested"
36337
36611
  },
36338
36612
  {
36339
- "id": "subscription_periods.getUdfInfo",
36340
- "resource": "subscription_periods",
36613
+ "id": "skills.getUdfInfo",
36614
+ "resource": "skills",
36341
36615
  "udfCapable": false,
36342
36616
  "operation": "getUdfInfo",
36343
36617
  "kind": "primitive",
36344
- "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/userDefinedFields",
36618
+ "endpoint": "GET /V1.0/Skills/entityInformation/userDefinedFields",
36345
36619
  "effect": "read",
36346
36620
  "flags": [],
36347
36621
  "dryRun": false,
@@ -36353,7 +36627,7 @@
36353
36627
  "drops": []
36354
36628
  },
36355
36629
  "examples": [
36356
- "await client.subscriptionPeriods.getUdfInfo()"
36630
+ "await client.skills.getUdfInfo()"
36357
36631
  ],
36358
36632
  "permissions": "unknown",
36359
36633
  "pagination": {
@@ -36367,23 +36641,27 @@
36367
36641
  "set": 0
36368
36642
  },
36369
36643
  "metadata": {
36370
- "purpose": "Get the SubscriptionPeriod user-defined-field catalog.",
36644
+ "purpose": "Get the Skill user-defined-field catalog.",
36371
36645
  "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
36372
36646
  "preferredWhen": null,
36373
36647
  "related": [
36374
- "subscription_periods.getFieldInfo"
36648
+ "skills.getFieldInfo"
36649
+ ],
36650
+ "untrustedFields": [
36651
+ "description",
36652
+ "name"
36375
36653
  ]
36376
36654
  },
36377
36655
  "compact": null,
36378
36656
  "status": "tested"
36379
36657
  },
36380
36658
  {
36381
- "id": "subscription_periods.query",
36382
- "resource": "subscription_periods",
36659
+ "id": "skills.query",
36660
+ "resource": "skills",
36383
36661
  "udfCapable": false,
36384
36662
  "operation": "query",
36385
36663
  "kind": "primitive",
36386
- "endpoint": "GET|POST /V1.0/SubscriptionPeriods/query",
36664
+ "endpoint": "GET|POST /V1.0/Skills/query",
36387
36665
  "effect": "read",
36388
36666
  "flags": [],
36389
36667
  "dryRun": false,
@@ -36455,7 +36733,7 @@
36455
36733
  "drops": []
36456
36734
  },
36457
36735
  "examples": [
36458
- "await client.subscriptionPeriods.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
36736
+ "await client.skills.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
36459
36737
  ],
36460
36738
  "permissions": "unknown",
36461
36739
  "pagination": {
@@ -36476,20 +36754,24 @@
36476
36754
  "set": 4
36477
36755
  },
36478
36756
  "metadata": {
36479
- "purpose": "Query SubscriptionPeriod records with a JSON filter.",
36757
+ "purpose": "Query Skill records with a JSON filter.",
36480
36758
  "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
36481
36759
  "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).",
36482
36760
  "related": [
36483
- "subscription_periods.resolve"
36761
+ "skills.resolve"
36484
36762
  ],
36485
- "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk."
36763
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer skills.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
36764
+ "untrustedFields": [
36765
+ "description",
36766
+ "name"
36767
+ ]
36486
36768
  },
36487
36769
  "compact": null,
36488
36770
  "status": "tested"
36489
36771
  },
36490
36772
  {
36491
- "id": "subscription_periods.resolve",
36492
- "resource": "subscription_periods",
36773
+ "id": "skills.resolve",
36774
+ "resource": "skills",
36493
36775
  "udfCapable": false,
36494
36776
  "operation": "resolve",
36495
36777
  "kind": "helper",
@@ -36519,11 +36801,11 @@
36519
36801
  },
36520
36802
  "inputSchemaStrict": true,
36521
36803
  "outputSchema": {
36522
- "type": "SubscriptionPeriodSummary",
36804
+ "type": "SkillSummary",
36523
36805
  "drops": []
36524
36806
  },
36525
36807
  "examples": [
36526
- "await client.subscriptionPeriods.resolve('example-value')"
36808
+ "await client.skills.resolve('example-value')"
36527
36809
  ],
36528
36810
  "permissions": "unknown",
36529
36811
  "pagination": {
@@ -36541,23 +36823,96 @@
36541
36823
  "set": 5
36542
36824
  },
36543
36825
  "metadata": {
36544
- "purpose": "Resolve a subscription period from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
36826
+ "purpose": "Resolve a skill from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Skill record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
36545
36827
  "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
36546
36828
  "preferredWhen": null,
36547
36829
  "related": [
36548
- "subscription_periods.get"
36830
+ "skills.get"
36831
+ ],
36832
+ "untrustedFields": [
36833
+ "description",
36834
+ "name"
36549
36835
  ]
36550
36836
  },
36551
- "compact": "SubscriptionPeriodSummary",
36837
+ "compact": "SkillSummary",
36552
36838
  "status": "tested"
36553
36839
  },
36554
36840
  {
36555
- "id": "survey_results.count",
36556
- "resource": "survey_results",
36841
+ "id": "skills.search",
36842
+ "resource": "skills",
36843
+ "udfCapable": false,
36844
+ "operation": "search",
36845
+ "kind": "helper",
36846
+ "endpoint": null,
36847
+ "effect": "read",
36848
+ "flags": [],
36849
+ "dryRun": false,
36850
+ "envelope": null,
36851
+ "inputSchema": {
36852
+ "query": {
36853
+ "type": "string",
36854
+ "required": true,
36855
+ "description": "The free text to match (contains) on the resource searchable fields."
36856
+ },
36857
+ "opts": {
36858
+ "type": "object",
36859
+ "required": false,
36860
+ "description": "SearchOpts — { limit?: number } (1-500, default 25).",
36861
+ "properties": [
36862
+ {
36863
+ "name": "limit",
36864
+ "type": "number",
36865
+ "optional": true
36866
+ }
36867
+ ]
36868
+ }
36869
+ },
36870
+ "inputSchemaStrict": true,
36871
+ "outputSchema": {
36872
+ "type": "SkillSummary",
36873
+ "drops": []
36874
+ },
36875
+ "examples": [
36876
+ "await client.skills.search('example')"
36877
+ ],
36878
+ "permissions": "unknown",
36879
+ "pagination": {
36880
+ "mode": "none"
36881
+ },
36882
+ "resolution": {
36883
+ "basis": "server-filter",
36884
+ "maxScanRecords": 500,
36885
+ "maxScanPages": 4
36886
+ },
36887
+ "retry": {
36888
+ "preset": "retry-ffb3a9cb"
36889
+ },
36890
+ "errors": {
36891
+ "set": 5
36892
+ },
36893
+ "metadata": {
36894
+ "purpose": "Search skill records by text (contains on the searchable fields).",
36895
+ "usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
36896
+ "preferredWhen": null,
36897
+ "related": [
36898
+ "skills.resolve",
36899
+ "skills.query"
36900
+ ],
36901
+ "untrustedFields": [
36902
+ "description",
36903
+ "name"
36904
+ ]
36905
+ },
36906
+ "compact": "SkillSummary",
36907
+ "status": "tested"
36908
+ },
36909
+ {
36910
+ "id": "subscription_periods.count",
36911
+ "resource": "subscription_periods",
36557
36912
  "udfCapable": false,
36558
36913
  "operation": "count",
36559
36914
  "kind": "primitive",
36560
- "endpoint": "GET|POST /V1.0/SurveyResults/query/count",
36915
+ "endpoint": "GET|POST /V1.0/SubscriptionPeriods/query/count",
36561
36916
  "effect": "read",
36562
36917
  "flags": [],
36563
36918
  "dryRun": false,
@@ -36587,7 +36942,7 @@
36587
36942
  "drops": []
36588
36943
  },
36589
36944
  "examples": [
36590
- "await client.surveyResults.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
36945
+ "await client.subscriptionPeriods.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
36591
36946
  ],
36592
36947
  "permissions": "unknown",
36593
36948
  "pagination": {
@@ -36601,11 +36956,11 @@
36601
36956
  "set": 0
36602
36957
  },
36603
36958
  "metadata": {
36604
- "purpose": "Count survey result records matching a JSON filter.",
36959
+ "purpose": "Count subscription period records matching a JSON filter.",
36605
36960
  "usage": "Unwraps queryCount; returns a plain number.",
36606
36961
  "preferredWhen": null,
36607
36962
  "related": [
36608
- "survey_results.query"
36963
+ "subscription_periods.query"
36609
36964
  ],
36610
36965
  "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars."
36611
36966
  },
@@ -36613,16 +36968,16 @@
36613
36968
  "status": "tested"
36614
36969
  },
36615
36970
  {
36616
- "id": "survey_results.get",
36617
- "resource": "survey_results",
36971
+ "id": "subscription_periods.get",
36972
+ "resource": "subscription_periods",
36618
36973
  "udfCapable": false,
36619
36974
  "operation": "get",
36620
36975
  "kind": "primitive",
36621
- "endpoint": "GET /V1.0/SurveyResults/{id}",
36976
+ "endpoint": "GET /V1.0/SubscriptionPeriods/{id}",
36622
36977
  "effect": "read",
36623
36978
  "flags": [],
36624
36979
  "dryRun": false,
36625
- "envelope": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
36980
+ "envelope": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
36626
36981
  "inputSchema": {
36627
36982
  "id": {
36628
36983
  "type": "string | number",
@@ -36644,11 +36999,11 @@
36644
36999
  },
36645
37000
  "inputSchemaStrict": true,
36646
37001
  "outputSchema": {
36647
- "type": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
37002
+ "type": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
36648
37003
  "drops": []
36649
37004
  },
36650
37005
  "examples": [
36651
- "await client.surveyResults.get('example-value')"
37006
+ "await client.subscriptionPeriods.get('example-value')"
36652
37007
  ],
36653
37008
  "permissions": "unknown",
36654
37009
  "pagination": {
@@ -36662,24 +37017,24 @@
36662
37017
  "set": 3
36663
37018
  },
36664
37019
  "metadata": {
36665
- "purpose": "Get one SurveyResults by id.",
37020
+ "purpose": "Get one SubscriptionPeriod by id.",
36666
37021
  "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
36667
- "preferredWhen": "Preferred when the numeric id is already known; survey_results.resolve is for a field value.",
37022
+ "preferredWhen": "Preferred when the numeric id is already known; subscription_periods.resolve is for a field value.",
36668
37023
  "related": [
36669
- "survey_results.resolve"
37024
+ "subscription_periods.resolve"
36670
37025
  ],
36671
- "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a survey_results.query with includeFields."
37026
+ "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a subscription_periods.query with includeFields."
36672
37027
  },
36673
37028
  "compact": null,
36674
37029
  "status": "tested"
36675
37030
  },
36676
37031
  {
36677
- "id": "survey_results.getEntityInfo",
36678
- "resource": "survey_results",
37032
+ "id": "subscription_periods.getEntityInfo",
37033
+ "resource": "subscription_periods",
36679
37034
  "udfCapable": false,
36680
37035
  "operation": "getEntityInfo",
36681
37036
  "kind": "primitive",
36682
- "endpoint": "GET /V1.0/SurveyResults/entityInformation",
37037
+ "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation",
36683
37038
  "effect": "read",
36684
37039
  "flags": [],
36685
37040
  "dryRun": false,
@@ -36691,7 +37046,7 @@
36691
37046
  "drops": []
36692
37047
  },
36693
37048
  "examples": [
36694
- "await client.surveyResults.getEntityInfo()"
37049
+ "await client.subscriptionPeriods.getEntityInfo()"
36695
37050
  ],
36696
37051
  "permissions": "unknown",
36697
37052
  "pagination": {
@@ -36705,23 +37060,23 @@
36705
37060
  "set": 0
36706
37061
  },
36707
37062
  "metadata": {
36708
- "purpose": "Get the SurveyResults capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
37063
+ "purpose": "Get the SubscriptionPeriod capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
36709
37064
  "usage": "Unwraps info{}; drives client-side capability checks.",
36710
37065
  "preferredWhen": null,
36711
37066
  "related": [
36712
- "survey_results.getFieldInfo"
37067
+ "subscription_periods.getFieldInfo"
36713
37068
  ]
36714
37069
  },
36715
37070
  "compact": null,
36716
37071
  "status": "tested"
36717
37072
  },
36718
37073
  {
36719
- "id": "survey_results.getFieldInfo",
36720
- "resource": "survey_results",
37074
+ "id": "subscription_periods.getFieldInfo",
37075
+ "resource": "subscription_periods",
36721
37076
  "udfCapable": false,
36722
37077
  "operation": "getFieldInfo",
36723
37078
  "kind": "primitive",
36724
- "endpoint": "GET /V1.0/SurveyResults/entityInformation/fields",
37079
+ "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/fields",
36725
37080
  "effect": "read",
36726
37081
  "flags": [],
36727
37082
  "dryRun": false,
@@ -36733,7 +37088,7 @@
36733
37088
  "drops": []
36734
37089
  },
36735
37090
  "examples": [
36736
- "await client.surveyResults.getFieldInfo()"
37091
+ "await client.subscriptionPeriods.getFieldInfo()"
36737
37092
  ],
36738
37093
  "permissions": "unknown",
36739
37094
  "pagination": {
@@ -36747,24 +37102,24 @@
36747
37102
  "set": 0
36748
37103
  },
36749
37104
  "metadata": {
36750
- "purpose": "Get the SurveyResults field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
37105
+ "purpose": "Get the SubscriptionPeriod field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
36751
37106
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
36752
37107
  "preferredWhen": null,
36753
37108
  "related": [
36754
- "survey_results.getEntityInfo",
36755
- "survey_results.getUdfInfo"
37109
+ "subscription_periods.getEntityInfo",
37110
+ "subscription_periods.getUdfInfo"
36756
37111
  ]
36757
37112
  },
36758
37113
  "compact": null,
36759
37114
  "status": "tested"
36760
37115
  },
36761
37116
  {
36762
- "id": "survey_results.getUdfInfo",
36763
- "resource": "survey_results",
37117
+ "id": "subscription_periods.getUdfInfo",
37118
+ "resource": "subscription_periods",
36764
37119
  "udfCapable": false,
36765
37120
  "operation": "getUdfInfo",
36766
37121
  "kind": "primitive",
36767
- "endpoint": "GET /V1.0/SurveyResults/entityInformation/userDefinedFields",
37122
+ "endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/userDefinedFields",
36768
37123
  "effect": "read",
36769
37124
  "flags": [],
36770
37125
  "dryRun": false,
@@ -36776,7 +37131,7 @@
36776
37131
  "drops": []
36777
37132
  },
36778
37133
  "examples": [
36779
- "await client.surveyResults.getUdfInfo()"
37134
+ "await client.subscriptionPeriods.getUdfInfo()"
36780
37135
  ],
36781
37136
  "permissions": "unknown",
36782
37137
  "pagination": {
@@ -36790,23 +37145,23 @@
36790
37145
  "set": 0
36791
37146
  },
36792
37147
  "metadata": {
36793
- "purpose": "Get the SurveyResults user-defined-field catalog.",
37148
+ "purpose": "Get the SubscriptionPeriod user-defined-field catalog.",
36794
37149
  "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
36795
37150
  "preferredWhen": null,
36796
37151
  "related": [
36797
- "survey_results.getFieldInfo"
37152
+ "subscription_periods.getFieldInfo"
36798
37153
  ]
36799
37154
  },
36800
37155
  "compact": null,
36801
37156
  "status": "tested"
36802
37157
  },
36803
37158
  {
36804
- "id": "survey_results.query",
36805
- "resource": "survey_results",
37159
+ "id": "subscription_periods.query",
37160
+ "resource": "subscription_periods",
36806
37161
  "udfCapable": false,
36807
37162
  "operation": "query",
36808
37163
  "kind": "primitive",
36809
- "endpoint": "GET|POST /V1.0/SurveyResults/query",
37164
+ "endpoint": "GET|POST /V1.0/SubscriptionPeriods/query",
36810
37165
  "effect": "read",
36811
37166
  "flags": [],
36812
37167
  "dryRun": false,
@@ -36878,7 +37233,7 @@
36878
37233
  "drops": []
36879
37234
  },
36880
37235
  "examples": [
36881
- "await client.surveyResults.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
37236
+ "await client.subscriptionPeriods.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
36882
37237
  ],
36883
37238
  "permissions": "unknown",
36884
37239
  "pagination": {
@@ -36899,11 +37254,11 @@
36899
37254
  "set": 4
36900
37255
  },
36901
37256
  "metadata": {
36902
- "purpose": "Query SurveyResults records with a JSON filter.",
37257
+ "purpose": "Query SubscriptionPeriod records with a JSON filter.",
36903
37258
  "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
36904
37259
  "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).",
36905
37260
  "related": [
36906
- "survey_results.resolve"
37261
+ "subscription_periods.resolve"
36907
37262
  ],
36908
37263
  "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk."
36909
37264
  },
@@ -36911,8 +37266,8 @@
36911
37266
  "status": "tested"
36912
37267
  },
36913
37268
  {
36914
- "id": "survey_results.resolve",
36915
- "resource": "survey_results",
37269
+ "id": "subscription_periods.resolve",
37270
+ "resource": "subscription_periods",
36916
37271
  "udfCapable": false,
36917
37272
  "operation": "resolve",
36918
37273
  "kind": "helper",
@@ -36942,11 +37297,11 @@
36942
37297
  },
36943
37298
  "inputSchemaStrict": true,
36944
37299
  "outputSchema": {
36945
- "type": "SurveyResultsSummary",
37300
+ "type": "SubscriptionPeriodSummary",
36946
37301
  "drops": []
36947
37302
  },
36948
37303
  "examples": [
36949
- "await client.surveyResults.resolve('example-value')"
37304
+ "await client.subscriptionPeriods.resolve('example-value')"
36950
37305
  ],
36951
37306
  "permissions": "unknown",
36952
37307
  "pagination": {
@@ -36964,23 +37319,23 @@
36964
37319
  "set": 5
36965
37320
  },
36966
37321
  "metadata": {
36967
- "purpose": "Resolve a survey result from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
37322
+ "purpose": "Resolve a subscription period from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
36968
37323
  "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
36969
37324
  "preferredWhen": null,
36970
37325
  "related": [
36971
- "survey_results.get"
37326
+ "subscription_periods.get"
36972
37327
  ]
36973
37328
  },
36974
- "compact": "SurveyResultsSummary",
37329
+ "compact": "SubscriptionPeriodSummary",
36975
37330
  "status": "tested"
36976
37331
  },
36977
37332
  {
36978
- "id": "surveys.count",
36979
- "resource": "surveys",
37333
+ "id": "survey_results.count",
37334
+ "resource": "survey_results",
36980
37335
  "udfCapable": false,
36981
37336
  "operation": "count",
36982
37337
  "kind": "primitive",
36983
- "endpoint": "GET|POST /V1.0/Surveys/query/count",
37338
+ "endpoint": "GET|POST /V1.0/SurveyResults/query/count",
36984
37339
  "effect": "read",
36985
37340
  "flags": [],
36986
37341
  "dryRun": false,
@@ -37010,7 +37365,7 @@
37010
37365
  "drops": []
37011
37366
  },
37012
37367
  "examples": [
37013
- "await client.surveys.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
37368
+ "await client.surveyResults.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
37014
37369
  ],
37015
37370
  "permissions": "unknown",
37016
37371
  "pagination": {
@@ -37024,33 +37379,28 @@
37024
37379
  "set": 0
37025
37380
  },
37026
37381
  "metadata": {
37027
- "purpose": "Count survey records matching a JSON filter.",
37382
+ "purpose": "Count survey result records matching a JSON filter.",
37028
37383
  "usage": "Unwraps queryCount; returns a plain number.",
37029
37384
  "preferredWhen": null,
37030
37385
  "related": [
37031
- "surveys.query"
37386
+ "survey_results.query"
37032
37387
  ],
37033
- "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
37034
- "untrustedFields": [
37035
- "description",
37036
- "displayName",
37037
- "name"
37038
- ]
37388
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars."
37039
37389
  },
37040
37390
  "compact": null,
37041
37391
  "status": "tested"
37042
37392
  },
37043
37393
  {
37044
- "id": "surveys.get",
37045
- "resource": "surveys",
37394
+ "id": "survey_results.get",
37395
+ "resource": "survey_results",
37046
37396
  "udfCapable": false,
37047
37397
  "operation": "get",
37048
37398
  "kind": "primitive",
37049
- "endpoint": "GET /V1.0/Surveys/{id}",
37399
+ "endpoint": "GET /V1.0/SurveyResults/{id}",
37050
37400
  "effect": "read",
37051
37401
  "flags": [],
37052
37402
  "dryRun": false,
37053
- "envelope": "ItemQueryResultModel[SurveyModel,Survey]",
37403
+ "envelope": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
37054
37404
  "inputSchema": {
37055
37405
  "id": {
37056
37406
  "type": "string | number",
@@ -37072,11 +37422,11 @@
37072
37422
  },
37073
37423
  "inputSchemaStrict": true,
37074
37424
  "outputSchema": {
37075
- "type": "ItemQueryResultModel[SurveyModel,Survey]",
37425
+ "type": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
37076
37426
  "drops": []
37077
37427
  },
37078
37428
  "examples": [
37079
- "await client.surveys.get('example-value')"
37429
+ "await client.surveyResults.get('example-value')"
37080
37430
  ],
37081
37431
  "permissions": "unknown",
37082
37432
  "pagination": {
@@ -37090,29 +37440,24 @@
37090
37440
  "set": 3
37091
37441
  },
37092
37442
  "metadata": {
37093
- "purpose": "Get one Survey by id.",
37443
+ "purpose": "Get one SurveyResults by id.",
37094
37444
  "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
37095
- "preferredWhen": "Preferred when the numeric id is already known; surveys.resolve is for a field value.",
37445
+ "preferredWhen": "Preferred when the numeric id is already known; survey_results.resolve is for a field value.",
37096
37446
  "related": [
37097
- "surveys.resolve"
37447
+ "survey_results.resolve"
37098
37448
  ],
37099
- "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use surveys.search (compact summary) or a surveys.query with includeFields.",
37100
- "untrustedFields": [
37101
- "description",
37102
- "displayName",
37103
- "name"
37104
- ]
37449
+ "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a survey_results.query with includeFields."
37105
37450
  },
37106
37451
  "compact": null,
37107
37452
  "status": "tested"
37108
37453
  },
37109
37454
  {
37110
- "id": "surveys.getEntityInfo",
37111
- "resource": "surveys",
37455
+ "id": "survey_results.getEntityInfo",
37456
+ "resource": "survey_results",
37112
37457
  "udfCapable": false,
37113
37458
  "operation": "getEntityInfo",
37114
37459
  "kind": "primitive",
37115
- "endpoint": "GET /V1.0/Surveys/entityInformation",
37460
+ "endpoint": "GET /V1.0/SurveyResults/entityInformation",
37116
37461
  "effect": "read",
37117
37462
  "flags": [],
37118
37463
  "dryRun": false,
@@ -37124,7 +37469,7 @@
37124
37469
  "drops": []
37125
37470
  },
37126
37471
  "examples": [
37127
- "await client.surveys.getEntityInfo()"
37472
+ "await client.surveyResults.getEntityInfo()"
37128
37473
  ],
37129
37474
  "permissions": "unknown",
37130
37475
  "pagination": {
@@ -37138,28 +37483,23 @@
37138
37483
  "set": 0
37139
37484
  },
37140
37485
  "metadata": {
37141
- "purpose": "Get the Survey capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
37486
+ "purpose": "Get the SurveyResults capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
37142
37487
  "usage": "Unwraps info{}; drives client-side capability checks.",
37143
37488
  "preferredWhen": null,
37144
37489
  "related": [
37145
- "surveys.getFieldInfo"
37146
- ],
37147
- "untrustedFields": [
37148
- "description",
37149
- "displayName",
37150
- "name"
37490
+ "survey_results.getFieldInfo"
37151
37491
  ]
37152
37492
  },
37153
37493
  "compact": null,
37154
37494
  "status": "tested"
37155
37495
  },
37156
37496
  {
37157
- "id": "surveys.getFieldInfo",
37158
- "resource": "surveys",
37497
+ "id": "survey_results.getFieldInfo",
37498
+ "resource": "survey_results",
37159
37499
  "udfCapable": false,
37160
37500
  "operation": "getFieldInfo",
37161
37501
  "kind": "primitive",
37162
- "endpoint": "GET /V1.0/Surveys/entityInformation/fields",
37502
+ "endpoint": "GET /V1.0/SurveyResults/entityInformation/fields",
37163
37503
  "effect": "read",
37164
37504
  "flags": [],
37165
37505
  "dryRun": false,
@@ -37171,7 +37511,7 @@
37171
37511
  "drops": []
37172
37512
  },
37173
37513
  "examples": [
37174
- "await client.surveys.getFieldInfo()"
37514
+ "await client.surveyResults.getFieldInfo()"
37175
37515
  ],
37176
37516
  "permissions": "unknown",
37177
37517
  "pagination": {
@@ -37185,29 +37525,24 @@
37185
37525
  "set": 0
37186
37526
  },
37187
37527
  "metadata": {
37188
- "purpose": "Get the Survey field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
37528
+ "purpose": "Get the SurveyResults field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
37189
37529
  "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
37190
37530
  "preferredWhen": null,
37191
37531
  "related": [
37192
- "surveys.getEntityInfo",
37193
- "surveys.getUdfInfo"
37194
- ],
37195
- "untrustedFields": [
37196
- "description",
37197
- "displayName",
37198
- "name"
37532
+ "survey_results.getEntityInfo",
37533
+ "survey_results.getUdfInfo"
37199
37534
  ]
37200
37535
  },
37201
37536
  "compact": null,
37202
37537
  "status": "tested"
37203
37538
  },
37204
37539
  {
37205
- "id": "surveys.getUdfInfo",
37206
- "resource": "surveys",
37540
+ "id": "survey_results.getUdfInfo",
37541
+ "resource": "survey_results",
37207
37542
  "udfCapable": false,
37208
37543
  "operation": "getUdfInfo",
37209
37544
  "kind": "primitive",
37210
- "endpoint": "GET /V1.0/Surveys/entityInformation/userDefinedFields",
37545
+ "endpoint": "GET /V1.0/SurveyResults/entityInformation/userDefinedFields",
37211
37546
  "effect": "read",
37212
37547
  "flags": [],
37213
37548
  "dryRun": false,
@@ -37219,7 +37554,7 @@
37219
37554
  "drops": []
37220
37555
  },
37221
37556
  "examples": [
37222
- "await client.surveys.getUdfInfo()"
37557
+ "await client.surveyResults.getUdfInfo()"
37223
37558
  ],
37224
37559
  "permissions": "unknown",
37225
37560
  "pagination": {
@@ -37233,28 +37568,471 @@
37233
37568
  "set": 0
37234
37569
  },
37235
37570
  "metadata": {
37236
- "purpose": "Get the Survey user-defined-field catalog.",
37571
+ "purpose": "Get the SurveyResults user-defined-field catalog.",
37237
37572
  "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
37238
37573
  "preferredWhen": null,
37239
37574
  "related": [
37240
- "surveys.getFieldInfo"
37241
- ],
37242
- "untrustedFields": [
37243
- "description",
37244
- "displayName",
37245
- "name"
37575
+ "survey_results.getFieldInfo"
37246
37576
  ]
37247
37577
  },
37248
37578
  "compact": null,
37249
37579
  "status": "tested"
37250
37580
  },
37251
37581
  {
37252
- "id": "surveys.query",
37253
- "resource": "surveys",
37582
+ "id": "survey_results.query",
37583
+ "resource": "survey_results",
37254
37584
  "udfCapable": false,
37255
37585
  "operation": "query",
37256
37586
  "kind": "primitive",
37257
- "endpoint": "GET|POST /V1.0/Surveys/query",
37587
+ "endpoint": "GET|POST /V1.0/SurveyResults/query",
37588
+ "effect": "read",
37589
+ "flags": [],
37590
+ "dryRun": false,
37591
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
37592
+ "inputSchema": {
37593
+ "params": {
37594
+ "type": "object",
37595
+ "required": false,
37596
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
37597
+ "properties": [
37598
+ {
37599
+ "name": "filter",
37600
+ "type": "FilterCondition[]",
37601
+ "optional": true
37602
+ },
37603
+ {
37604
+ "name": "limit",
37605
+ "type": "number",
37606
+ "optional": true,
37607
+ "default": 500
37608
+ },
37609
+ {
37610
+ "name": "latest",
37611
+ "type": "number",
37612
+ "optional": true
37613
+ },
37614
+ {
37615
+ "name": "noteChars",
37616
+ "type": "number",
37617
+ "optional": true
37618
+ },
37619
+ {
37620
+ "name": "includeFields",
37621
+ "type": "string[]",
37622
+ "optional": true
37623
+ },
37624
+ {
37625
+ "name": "fieldCheck",
37626
+ "type": "boolean",
37627
+ "optional": true,
37628
+ "default": true
37629
+ },
37630
+ {
37631
+ "name": "names",
37632
+ "type": "boolean",
37633
+ "optional": true
37634
+ },
37635
+ {
37636
+ "name": "via",
37637
+ "type": "\"post\" | \"get\"",
37638
+ "optional": true
37639
+ },
37640
+ {
37641
+ "name": "acknowledgeUnscoped",
37642
+ "type": "boolean",
37643
+ "optional": true
37644
+ },
37645
+ {
37646
+ "name": "walk",
37647
+ "type": "object",
37648
+ "optional": true
37649
+ }
37650
+ ]
37651
+ }
37652
+ },
37653
+ "inputSchemaStrict": true,
37654
+ "outputSchema": {
37655
+ "type": "QueryActionResult[<Model>,<Entity>]",
37656
+ "drops": []
37657
+ },
37658
+ "examples": [
37659
+ "await client.surveyResults.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
37660
+ ],
37661
+ "permissions": "unknown",
37662
+ "pagination": {
37663
+ "mode": "cursor",
37664
+ "vendorDefault": 10,
37665
+ "vendorMax": 500,
37666
+ "pageGuard": 1000,
37667
+ "queryBounded": {
37668
+ "default": 500,
37669
+ "max": 2500
37670
+ }
37671
+ },
37672
+ "resolution": null,
37673
+ "retry": {
37674
+ "preset": "retry-ffb3a9cb"
37675
+ },
37676
+ "errors": {
37677
+ "set": 4
37678
+ },
37679
+ "metadata": {
37680
+ "purpose": "Query SurveyResults records with a JSON filter.",
37681
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
37682
+ "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).",
37683
+ "related": [
37684
+ "survey_results.resolve"
37685
+ ],
37686
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk."
37687
+ },
37688
+ "compact": null,
37689
+ "status": "tested"
37690
+ },
37691
+ {
37692
+ "id": "survey_results.resolve",
37693
+ "resource": "survey_results",
37694
+ "udfCapable": false,
37695
+ "operation": "resolve",
37696
+ "kind": "helper",
37697
+ "endpoint": null,
37698
+ "effect": "read",
37699
+ "flags": [],
37700
+ "dryRun": false,
37701
+ "envelope": null,
37702
+ "inputSchema": {
37703
+ "identifier": {
37704
+ "type": "string | number",
37705
+ "required": true,
37706
+ "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
37707
+ },
37708
+ "opts": {
37709
+ "type": "object",
37710
+ "required": false,
37711
+ "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
37712
+ "properties": [
37713
+ {
37714
+ "name": "expand",
37715
+ "type": "boolean",
37716
+ "optional": true
37717
+ }
37718
+ ]
37719
+ }
37720
+ },
37721
+ "inputSchemaStrict": true,
37722
+ "outputSchema": {
37723
+ "type": "SurveyResultsSummary",
37724
+ "drops": []
37725
+ },
37726
+ "examples": [
37727
+ "await client.surveyResults.resolve('example-value')"
37728
+ ],
37729
+ "permissions": "unknown",
37730
+ "pagination": {
37731
+ "mode": "none"
37732
+ },
37733
+ "resolution": {
37734
+ "basis": "server-filter",
37735
+ "maxScanRecords": 500,
37736
+ "maxScanPages": 4
37737
+ },
37738
+ "retry": {
37739
+ "preset": "retry-ffb3a9cb"
37740
+ },
37741
+ "errors": {
37742
+ "set": 5
37743
+ },
37744
+ "metadata": {
37745
+ "purpose": "Resolve a survey result from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
37746
+ "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
37747
+ "preferredWhen": null,
37748
+ "related": [
37749
+ "survey_results.get"
37750
+ ]
37751
+ },
37752
+ "compact": "SurveyResultsSummary",
37753
+ "status": "tested"
37754
+ },
37755
+ {
37756
+ "id": "surveys.count",
37757
+ "resource": "surveys",
37758
+ "udfCapable": false,
37759
+ "operation": "count",
37760
+ "kind": "primitive",
37761
+ "endpoint": "GET|POST /V1.0/Surveys/query/count",
37762
+ "effect": "read",
37763
+ "flags": [],
37764
+ "dryRun": false,
37765
+ "envelope": "QueryCountResultModel",
37766
+ "inputSchema": {
37767
+ "params": {
37768
+ "type": "object",
37769
+ "required": false,
37770
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
37771
+ "properties": [
37772
+ {
37773
+ "name": "filter",
37774
+ "type": "FilterCondition[]",
37775
+ "optional": true
37776
+ },
37777
+ {
37778
+ "name": "fieldCheck",
37779
+ "type": "boolean",
37780
+ "optional": true
37781
+ }
37782
+ ]
37783
+ }
37784
+ },
37785
+ "inputSchemaStrict": true,
37786
+ "outputSchema": {
37787
+ "type": "QueryCountResultModel",
37788
+ "drops": []
37789
+ },
37790
+ "examples": [
37791
+ "await client.surveys.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
37792
+ ],
37793
+ "permissions": "unknown",
37794
+ "pagination": {
37795
+ "mode": "none"
37796
+ },
37797
+ "resolution": null,
37798
+ "retry": {
37799
+ "preset": "retry-ffb3a9cb"
37800
+ },
37801
+ "errors": {
37802
+ "set": 0
37803
+ },
37804
+ "metadata": {
37805
+ "purpose": "Count survey records matching a JSON filter.",
37806
+ "usage": "Unwraps queryCount; returns a plain number.",
37807
+ "preferredWhen": null,
37808
+ "related": [
37809
+ "surveys.query"
37810
+ ],
37811
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
37812
+ "untrustedFields": [
37813
+ "description",
37814
+ "displayName",
37815
+ "name"
37816
+ ]
37817
+ },
37818
+ "compact": null,
37819
+ "status": "tested"
37820
+ },
37821
+ {
37822
+ "id": "surveys.get",
37823
+ "resource": "surveys",
37824
+ "udfCapable": false,
37825
+ "operation": "get",
37826
+ "kind": "primitive",
37827
+ "endpoint": "GET /V1.0/Surveys/{id}",
37828
+ "effect": "read",
37829
+ "flags": [],
37830
+ "dryRun": false,
37831
+ "envelope": "ItemQueryResultModel[SurveyModel,Survey]",
37832
+ "inputSchema": {
37833
+ "id": {
37834
+ "type": "string | number",
37835
+ "required": true,
37836
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
37837
+ },
37838
+ "opts": {
37839
+ "type": "object",
37840
+ "required": false,
37841
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
37842
+ "properties": [
37843
+ {
37844
+ "name": "fresh",
37845
+ "type": "boolean",
37846
+ "optional": true
37847
+ }
37848
+ ]
37849
+ }
37850
+ },
37851
+ "inputSchemaStrict": true,
37852
+ "outputSchema": {
37853
+ "type": "ItemQueryResultModel[SurveyModel,Survey]",
37854
+ "drops": []
37855
+ },
37856
+ "examples": [
37857
+ "await client.surveys.get('example-value')"
37858
+ ],
37859
+ "permissions": "unknown",
37860
+ "pagination": {
37861
+ "mode": "none"
37862
+ },
37863
+ "resolution": null,
37864
+ "retry": {
37865
+ "preset": "retry-ffb3a9cb"
37866
+ },
37867
+ "errors": {
37868
+ "set": 3
37869
+ },
37870
+ "metadata": {
37871
+ "purpose": "Get one Survey by id.",
37872
+ "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
37873
+ "preferredWhen": "Preferred when the numeric id is already known; surveys.resolve is for a field value.",
37874
+ "related": [
37875
+ "surveys.resolve"
37876
+ ],
37877
+ "args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use surveys.search (compact summary) or a surveys.query with includeFields.",
37878
+ "untrustedFields": [
37879
+ "description",
37880
+ "displayName",
37881
+ "name"
37882
+ ]
37883
+ },
37884
+ "compact": null,
37885
+ "status": "tested"
37886
+ },
37887
+ {
37888
+ "id": "surveys.getEntityInfo",
37889
+ "resource": "surveys",
37890
+ "udfCapable": false,
37891
+ "operation": "getEntityInfo",
37892
+ "kind": "primitive",
37893
+ "endpoint": "GET /V1.0/Surveys/entityInformation",
37894
+ "effect": "read",
37895
+ "flags": [],
37896
+ "dryRun": false,
37897
+ "envelope": "EntityInformationResultModel",
37898
+ "inputSchema": {},
37899
+ "inputSchemaStrict": true,
37900
+ "outputSchema": {
37901
+ "type": "EntityInformationResultModel",
37902
+ "drops": []
37903
+ },
37904
+ "examples": [
37905
+ "await client.surveys.getEntityInfo()"
37906
+ ],
37907
+ "permissions": "unknown",
37908
+ "pagination": {
37909
+ "mode": "none"
37910
+ },
37911
+ "resolution": null,
37912
+ "retry": {
37913
+ "preset": "retry-ffb3a9cb"
37914
+ },
37915
+ "errors": {
37916
+ "set": 0
37917
+ },
37918
+ "metadata": {
37919
+ "purpose": "Get the Survey capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
37920
+ "usage": "Unwraps info{}; drives client-side capability checks.",
37921
+ "preferredWhen": null,
37922
+ "related": [
37923
+ "surveys.getFieldInfo"
37924
+ ],
37925
+ "untrustedFields": [
37926
+ "description",
37927
+ "displayName",
37928
+ "name"
37929
+ ]
37930
+ },
37931
+ "compact": null,
37932
+ "status": "tested"
37933
+ },
37934
+ {
37935
+ "id": "surveys.getFieldInfo",
37936
+ "resource": "surveys",
37937
+ "udfCapable": false,
37938
+ "operation": "getFieldInfo",
37939
+ "kind": "primitive",
37940
+ "endpoint": "GET /V1.0/Surveys/entityInformation/fields",
37941
+ "effect": "read",
37942
+ "flags": [],
37943
+ "dryRun": false,
37944
+ "envelope": "FieldInformationResultModel",
37945
+ "inputSchema": {},
37946
+ "inputSchemaStrict": true,
37947
+ "outputSchema": {
37948
+ "type": "FieldInformationResultModel",
37949
+ "drops": []
37950
+ },
37951
+ "examples": [
37952
+ "await client.surveys.getFieldInfo()"
37953
+ ],
37954
+ "permissions": "unknown",
37955
+ "pagination": {
37956
+ "mode": "none"
37957
+ },
37958
+ "resolution": null,
37959
+ "retry": {
37960
+ "preset": "retry-ffb3a9cb"
37961
+ },
37962
+ "errors": {
37963
+ "set": 0
37964
+ },
37965
+ "metadata": {
37966
+ "purpose": "Get the Survey field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
37967
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
37968
+ "preferredWhen": null,
37969
+ "related": [
37970
+ "surveys.getEntityInfo",
37971
+ "surveys.getUdfInfo"
37972
+ ],
37973
+ "untrustedFields": [
37974
+ "description",
37975
+ "displayName",
37976
+ "name"
37977
+ ]
37978
+ },
37979
+ "compact": null,
37980
+ "status": "tested"
37981
+ },
37982
+ {
37983
+ "id": "surveys.getUdfInfo",
37984
+ "resource": "surveys",
37985
+ "udfCapable": false,
37986
+ "operation": "getUdfInfo",
37987
+ "kind": "primitive",
37988
+ "endpoint": "GET /V1.0/Surveys/entityInformation/userDefinedFields",
37989
+ "effect": "read",
37990
+ "flags": [],
37991
+ "dryRun": false,
37992
+ "envelope": "UserDefinedFieldInformationResultModel",
37993
+ "inputSchema": {},
37994
+ "inputSchemaStrict": true,
37995
+ "outputSchema": {
37996
+ "type": "UserDefinedFieldInformationResultModel",
37997
+ "drops": []
37998
+ },
37999
+ "examples": [
38000
+ "await client.surveys.getUdfInfo()"
38001
+ ],
38002
+ "permissions": "unknown",
38003
+ "pagination": {
38004
+ "mode": "none"
38005
+ },
38006
+ "resolution": null,
38007
+ "retry": {
38008
+ "preset": "retry-ffb3a9cb"
38009
+ },
38010
+ "errors": {
38011
+ "set": 0
38012
+ },
38013
+ "metadata": {
38014
+ "purpose": "Get the Survey user-defined-field catalog.",
38015
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
38016
+ "preferredWhen": null,
38017
+ "related": [
38018
+ "surveys.getFieldInfo"
38019
+ ],
38020
+ "untrustedFields": [
38021
+ "description",
38022
+ "displayName",
38023
+ "name"
38024
+ ]
38025
+ },
38026
+ "compact": null,
38027
+ "status": "tested"
38028
+ },
38029
+ {
38030
+ "id": "surveys.query",
38031
+ "resource": "surveys",
38032
+ "udfCapable": false,
38033
+ "operation": "query",
38034
+ "kind": "primitive",
38035
+ "endpoint": "GET|POST /V1.0/Surveys/query",
37258
38036
  "effect": "read",
37259
38037
  "flags": [],
37260
38038
  "dryRun": false,
@@ -42937,7 +43715,7 @@
42937
43715
  "preset": "retry-ffb3a9cb"
42938
43716
  },
42939
43717
  "errors": {
42940
- "set": 11
43718
+ "set": 13
42941
43719
  },
42942
43720
  "metadata": {
42943
43721
  "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.",
@@ -46603,8 +47381,8 @@
46603
47381
  ]
46604
47382
  },
46605
47383
  "A": {
46606
- "planHash": "2f78ad6e25fd96f024dfc749c3c9d1b8dbf52d8a23e097bd5046605a9975787c",
46607
- "builtAt": "2026-11-21T03:40:52.140Z",
47384
+ "planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
47385
+ "builtAt": "2026-11-21T07:49:35.531Z",
46608
47386
  "records": [
46609
47387
  {
46610
47388
  "id": "attachment_info.count",
@@ -47257,7 +48035,7 @@
47257
48035
  "preset": "retry-ffb3a9cb"
47258
48036
  },
47259
48037
  "errors": {
47260
- "set": 12
48038
+ "set": 14
47261
48039
  },
47262
48040
  "metadata": {
47263
48041
  "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.",
@@ -47446,7 +48224,7 @@
47446
48224
  "preset": "retry-ffb3a9cb"
47447
48225
  },
47448
48226
  "errors": {
47449
- "set": 13
48227
+ "set": 15
47450
48228
  },
47451
48229
  "metadata": {
47452
48230
  "purpose": "Get a company with its primary context records in one call.",
@@ -47732,7 +48510,7 @@
47732
48510
  "preset": "retry-ffb3a9cb"
47733
48511
  },
47734
48512
  "errors": {
47735
- "set": 13
48513
+ "set": 15
47736
48514
  },
47737
48515
  "metadata": {
47738
48516
  "purpose": "Plan a CRM write: from partial company/contact details, find the company, its locations and the location to link a contact to, duplicate contacts, the required fields still missing (with how to get each) and the next atomic write to preview.",
@@ -48486,7 +49264,7 @@
48486
49264
  "preset": "retry-ffb3a9cb"
48487
49265
  },
48488
49266
  "errors": {
48489
- "set": 14
49267
+ "set": 16
48490
49268
  },
48491
49269
  "metadata": {
48492
49270
  "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",
@@ -57792,7 +58570,7 @@
57792
58570
  "preset": "retry-ffb3a9cb"
57793
58571
  },
57794
58572
  "errors": {
57795
- "set": 13
58573
+ "set": 15
57796
58574
  },
57797
58575
  "metadata": {
57798
58576
  "purpose": "Get a configuration item with its primary context records in one call.",
@@ -58185,7 +58963,7 @@
58185
58963
  "preset": "retry-ffb3a9cb"
58186
58964
  },
58187
58965
  "errors": {
58188
- "set": 14
58966
+ "set": 16
58189
58967
  },
58190
58968
  "metadata": {
58191
58969
  "purpose": "Get the full profile of one configuration item in a single call: the item, its type, category and product records, its notes, related items, billing-product associations and subscriptions (software/licence terms keyed by configurationItemID).",
@@ -59773,7 +60551,7 @@
59773
60551
  "preset": "retry-ffb3a9cb"
59774
60552
  },
59775
60553
  "errors": {
59776
- "set": 9
60554
+ "set": 11
59777
60555
  },
59778
60556
  "metadata": {
59779
60557
  "purpose": "Get a contact with its company and its open tickets in a single call: the contact (the parent-scoped root read, or row when the contact has no company FK), its company, and its open tickets — every part separately reported.",
@@ -59961,7 +60739,7 @@
59961
60739
  "preset": "retry-ffb3a9cb"
59962
60740
  },
59963
60741
  "errors": {
59964
- "set": 13
60742
+ "set": 15
59965
60743
  },
59966
60744
  "metadata": {
59967
60745
  "purpose": "Get a contact with its primary context records in one call. (under a company)",
@@ -70901,7 +71679,7 @@
70901
71679
  "preset": "retry-ffb3a9cb"
70902
71680
  },
70903
71681
  "errors": {
70904
- "set": 10
71682
+ "set": 12
70905
71683
  },
70906
71684
  "metadata": {
70907
71685
  "purpose": "Get a contract with its services, billing rules, recent charges and service units in a single call — the charges part is the N newest (the count-anchored `latest` 50).",
@@ -71277,7 +72055,7 @@
71277
72055
  "preset": "retry-ffb3a9cb"
71278
72056
  },
71279
72057
  "errors": {
71280
- "set": 14
72058
+ "set": 16
71281
72059
  },
71282
72060
  "metadata": {
71283
72061
  "purpose": "Get the Line of Business chain for one contract in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
@@ -71427,7 +72205,7 @@
71427
72205
  "preset": "retry-ffb3a9cb"
71428
72206
  },
71429
72207
  "errors": {
71430
- "set": 14
72208
+ "set": 16
71431
72209
  },
71432
72210
  "metadata": {
71433
72211
  "purpose": "One call for a contract's profit-and-loss over a date window: monthly revenue (invoiced vs expected-but-unbilled), labour cost through an audited four-rung rate ladder, tooling/recurring/expense costs, break-even hours, the ticketCategory activity fold, the costliest tickets, suspected miscoded time, open/renewal items, and 11 built-in data-quality warnings",
@@ -71599,7 +72377,745 @@
71599
72377
  "drops": []
71600
72378
  },
71601
72379
  "examples": [
71602
- "await client.contracts.query({ filter: [{ field: 'contractName', op: 'eq', value: 'example' }], limit: 500 })"
72380
+ "await client.contracts.query({ filter: [{ field: 'contractName', op: 'eq', value: 'example' }], limit: 500 })"
72381
+ ],
72382
+ "permissions": "unknown",
72383
+ "pagination": {
72384
+ "mode": "cursor",
72385
+ "vendorDefault": 10,
72386
+ "vendorMax": 500,
72387
+ "pageGuard": 1000,
72388
+ "queryBounded": {
72389
+ "default": 500,
72390
+ "max": 2500
72391
+ }
72392
+ },
72393
+ "resolution": null,
72394
+ "retry": {
72395
+ "preset": "retry-ffb3a9cb"
72396
+ },
72397
+ "errors": {
72398
+ "set": 4
72399
+ },
72400
+ "metadata": {
72401
+ "purpose": "Query Contract records with a JSON filter.",
72402
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
72403
+ "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).",
72404
+ "related": [
72405
+ "contracts.resolve"
72406
+ ],
72407
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer contracts.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
72408
+ "untrustedFields": [
72409
+ "UDF1",
72410
+ "UDF10",
72411
+ "UDF11",
72412
+ "UDF12",
72413
+ "UDF13",
72414
+ "UDF14",
72415
+ "UDF15",
72416
+ "UDF16",
72417
+ "UDF17",
72418
+ "UDF18",
72419
+ "UDF19",
72420
+ "UDF2",
72421
+ "UDF20",
72422
+ "UDF3",
72423
+ "UDF4",
72424
+ "UDF5",
72425
+ "UDF6",
72426
+ "UDF7",
72427
+ "UDF8",
72428
+ "UDF9",
72429
+ "contactName",
72430
+ "contractName",
72431
+ "description"
72432
+ ]
72433
+ },
72434
+ "compact": null,
72435
+ "status": "tested"
72436
+ },
72437
+ {
72438
+ "id": "contracts.resolve",
72439
+ "resource": "contracts",
72440
+ "udfCapable": true,
72441
+ "operation": "resolve",
72442
+ "kind": "helper",
72443
+ "endpoint": null,
72444
+ "effect": "read",
72445
+ "flags": [],
72446
+ "dryRun": false,
72447
+ "envelope": null,
72448
+ "inputSchema": {
72449
+ "identifier": {
72450
+ "type": "string | number",
72451
+ "required": true,
72452
+ "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
72453
+ },
72454
+ "opts": {
72455
+ "type": "object",
72456
+ "required": false,
72457
+ "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
72458
+ "properties": [
72459
+ {
72460
+ "name": "expand",
72461
+ "type": "boolean",
72462
+ "optional": true
72463
+ }
72464
+ ]
72465
+ }
72466
+ },
72467
+ "inputSchemaStrict": true,
72468
+ "outputSchema": {
72469
+ "type": "ContractSummary",
72470
+ "drops": []
72471
+ },
72472
+ "examples": [
72473
+ "await client.contracts.resolve('example-value')"
72474
+ ],
72475
+ "permissions": "unknown",
72476
+ "pagination": {
72477
+ "mode": "none"
72478
+ },
72479
+ "resolution": {
72480
+ "basis": "server-filter",
72481
+ "maxScanRecords": 500,
72482
+ "maxScanPages": 4
72483
+ },
72484
+ "retry": {
72485
+ "preset": "retry-ffb3a9cb"
72486
+ },
72487
+ "errors": {
72488
+ "set": 5
72489
+ },
72490
+ "metadata": {
72491
+ "purpose": "Resolve a contract from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (contractName — exact match only). Returns the Contract record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
72492
+ "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
72493
+ "preferredWhen": null,
72494
+ "related": [
72495
+ "contracts.get"
72496
+ ],
72497
+ "untrustedFields": [
72498
+ "UDF1",
72499
+ "UDF10",
72500
+ "UDF11",
72501
+ "UDF12",
72502
+ "UDF13",
72503
+ "UDF14",
72504
+ "UDF15",
72505
+ "UDF16",
72506
+ "UDF17",
72507
+ "UDF18",
72508
+ "UDF19",
72509
+ "UDF2",
72510
+ "UDF20",
72511
+ "UDF3",
72512
+ "UDF4",
72513
+ "UDF5",
72514
+ "UDF6",
72515
+ "UDF7",
72516
+ "UDF8",
72517
+ "UDF9",
72518
+ "contactName",
72519
+ "contractName",
72520
+ "description"
72521
+ ]
72522
+ },
72523
+ "compact": "ContractSummary",
72524
+ "status": "tested"
72525
+ },
72526
+ {
72527
+ "id": "contracts.search",
72528
+ "resource": "contracts",
72529
+ "udfCapable": true,
72530
+ "operation": "search",
72531
+ "kind": "helper",
72532
+ "endpoint": null,
72533
+ "effect": "read",
72534
+ "flags": [],
72535
+ "dryRun": false,
72536
+ "envelope": null,
72537
+ "inputSchema": {
72538
+ "query": {
72539
+ "type": "string",
72540
+ "required": true,
72541
+ "description": "The free text to match (contains) on the resource searchable fields."
72542
+ },
72543
+ "opts": {
72544
+ "type": "object",
72545
+ "required": false,
72546
+ "description": "SearchOpts — { limit?: number } (1-500, default 25).",
72547
+ "properties": [
72548
+ {
72549
+ "name": "limit",
72550
+ "type": "number",
72551
+ "optional": true
72552
+ }
72553
+ ]
72554
+ }
72555
+ },
72556
+ "inputSchemaStrict": true,
72557
+ "outputSchema": {
72558
+ "type": "ContractSummary",
72559
+ "drops": []
72560
+ },
72561
+ "examples": [
72562
+ "await client.contracts.search('example')"
72563
+ ],
72564
+ "permissions": "unknown",
72565
+ "pagination": {
72566
+ "mode": "none"
72567
+ },
72568
+ "resolution": {
72569
+ "basis": "server-filter",
72570
+ "maxScanRecords": 500,
72571
+ "maxScanPages": 4
72572
+ },
72573
+ "retry": {
72574
+ "preset": "retry-ffb3a9cb"
72575
+ },
72576
+ "errors": {
72577
+ "set": 5
72578
+ },
72579
+ "metadata": {
72580
+ "purpose": "Search contract records by text (contains on the searchable fields).",
72581
+ "usage": "Vendor exposes no free-text search; this is a bounded contains filter: contractName only (contains). limit defaults to 25, max 500.",
72582
+ "preferredWhen": null,
72583
+ "related": [
72584
+ "contracts.resolve",
72585
+ "contracts.query"
72586
+ ],
72587
+ "untrustedFields": [
72588
+ "UDF1",
72589
+ "UDF10",
72590
+ "UDF11",
72591
+ "UDF12",
72592
+ "UDF13",
72593
+ "UDF14",
72594
+ "UDF15",
72595
+ "UDF16",
72596
+ "UDF17",
72597
+ "UDF18",
72598
+ "UDF19",
72599
+ "UDF2",
72600
+ "UDF20",
72601
+ "UDF3",
72602
+ "UDF4",
72603
+ "UDF5",
72604
+ "UDF6",
72605
+ "UDF7",
72606
+ "UDF8",
72607
+ "UDF9",
72608
+ "contactName",
72609
+ "contractName",
72610
+ "description"
72611
+ ]
72612
+ },
72613
+ "compact": "ContractSummary",
72614
+ "status": "tested"
72615
+ },
72616
+ {
72617
+ "id": "contracts.update",
72618
+ "resource": "contracts",
72619
+ "udfCapable": true,
72620
+ "operation": "update",
72621
+ "kind": "primitive",
72622
+ "endpoint": "PUT|PATCH /V1.0/Contracts",
72623
+ "effect": "write",
72624
+ "flags": [
72625
+ "idempotent"
72626
+ ],
72627
+ "dryRun": true,
72628
+ "envelope": "OperationResultModel",
72629
+ "inputSchema": {
72630
+ "id": {
72631
+ "type": "string | number",
72632
+ "required": true,
72633
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
72634
+ },
72635
+ "data": {
72636
+ "type": "object",
72637
+ "required": true,
72638
+ "description": "The record payload (vendor model fields)."
72639
+ }
72640
+ },
72641
+ "inputSchemaStrict": true,
72642
+ "outputSchema": {
72643
+ "type": "OperationResultModel",
72644
+ "drops": []
72645
+ },
72646
+ "examples": [
72647
+ "await client.contracts.update('example-value', { contractName: 'example' }, { dryRun: true })"
72648
+ ],
72649
+ "permissions": "unknown",
72650
+ "pagination": {
72651
+ "mode": "none"
72652
+ },
72653
+ "resolution": null,
72654
+ "retry": {
72655
+ "preset": "retry-1849870d"
72656
+ },
72657
+ "errors": {
72658
+ "set": 1
72659
+ },
72660
+ "metadata": {
72661
+ "purpose": "Update a contract.",
72662
+ "usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) 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).",
72663
+ "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
72664
+ "related": [
72665
+ "contracts.get"
72666
+ ],
72667
+ "collectionUpdate": true,
72668
+ "untrustedFields": [
72669
+ "UDF1",
72670
+ "UDF10",
72671
+ "UDF11",
72672
+ "UDF12",
72673
+ "UDF13",
72674
+ "UDF14",
72675
+ "UDF15",
72676
+ "UDF16",
72677
+ "UDF17",
72678
+ "UDF18",
72679
+ "UDF19",
72680
+ "UDF2",
72681
+ "UDF20",
72682
+ "UDF3",
72683
+ "UDF4",
72684
+ "UDF5",
72685
+ "UDF6",
72686
+ "UDF7",
72687
+ "UDF8",
72688
+ "UDF9",
72689
+ "contactName",
72690
+ "contractName",
72691
+ "description"
72692
+ ],
72693
+ "writeQuirks": {
72694
+ "dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
72695
+ }
72696
+ },
72697
+ "compact": null,
72698
+ "status": "tested"
72699
+ },
72700
+ {
72701
+ "id": "inventory_items.count",
72702
+ "resource": "inventory_items",
72703
+ "udfCapable": false,
72704
+ "operation": "count",
72705
+ "kind": "primitive",
72706
+ "endpoint": "POST /V1.0/InventoryItems/query/count",
72707
+ "effect": "read",
72708
+ "flags": [],
72709
+ "dryRun": false,
72710
+ "envelope": "QueryCountResultModel",
72711
+ "inputSchema": {
72712
+ "params": {
72713
+ "type": "object",
72714
+ "required": false,
72715
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
72716
+ "properties": [
72717
+ {
72718
+ "name": "filter",
72719
+ "type": "FilterCondition[]",
72720
+ "optional": true
72721
+ },
72722
+ {
72723
+ "name": "fieldCheck",
72724
+ "type": "boolean",
72725
+ "optional": true
72726
+ }
72727
+ ]
72728
+ }
72729
+ },
72730
+ "inputSchemaStrict": true,
72731
+ "outputSchema": {
72732
+ "type": "QueryCountResultModel",
72733
+ "drops": []
72734
+ },
72735
+ "examples": [
72736
+ "await invoke(client, 'inventory_items.count', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }] }])"
72737
+ ],
72738
+ "permissions": "unknown",
72739
+ "pagination": {
72740
+ "mode": "none"
72741
+ },
72742
+ "resolution": null,
72743
+ "retry": {
72744
+ "preset": "retry-ffb3a9cb"
72745
+ },
72746
+ "errors": {
72747
+ "set": 6
72748
+ },
72749
+ "metadata": {
72750
+ "purpose": "Count inventory item records matching a JSON filter.",
72751
+ "usage": "Unwraps queryCount; returns a plain number. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
72752
+ "preferredWhen": null,
72753
+ "related": [
72754
+ "inventory_items.query"
72755
+ ],
72756
+ "args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / no UDFs / 8000 chars.",
72757
+ "untrustedFields": [
72758
+ "bin",
72759
+ "referenceNumber"
72760
+ ]
72761
+ },
72762
+ "compact": null,
72763
+ "status": "tested"
72764
+ },
72765
+ {
72766
+ "id": "inventory_items.create",
72767
+ "resource": "inventory_items",
72768
+ "udfCapable": false,
72769
+ "operation": "create",
72770
+ "kind": "primitive",
72771
+ "endpoint": "POST /V1.0/InventoryItems",
72772
+ "effect": "write",
72773
+ "flags": [],
72774
+ "dryRun": true,
72775
+ "envelope": "OperationResultModel",
72776
+ "inputSchema": {
72777
+ "data": {
72778
+ "type": "object",
72779
+ "required": true,
72780
+ "description": "The record payload (vendor model fields)."
72781
+ }
72782
+ },
72783
+ "inputSchemaStrict": true,
72784
+ "outputSchema": {
72785
+ "type": "OperationResultModel",
72786
+ "drops": []
72787
+ },
72788
+ "examples": [
72789
+ "await client.inventoryItems.create({ productID: 3, inventoryLocationID: 7, quantityMinimum: 0, quantityMaximum: 10, quantityOnHand: 0 }, { dryRun: true })"
72790
+ ],
72791
+ "permissions": "unknown",
72792
+ "pagination": {
72793
+ "mode": "none"
72794
+ },
72795
+ "resolution": null,
72796
+ "retry": {
72797
+ "preset": "retry-c5657094"
72798
+ },
72799
+ "errors": {
72800
+ "set": 17
72801
+ },
72802
+ "metadata": {
72803
+ "purpose": "Create a product-location inventory item.",
72804
+ "usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Supply productID, inventoryLocationID, quantityMinimum, quantityMaximum and quantityOnHand. Product and location are verified before preview or apply. The location must be active and initial quantityOnHand must be nonnegative. Serialized products require zero on-hand. Autotask controls pair uniqueness and initializes read-only counters. No public DELETE exists. Preview first.",
72805
+ "preferredWhen": "Use for a new product-location pair after checking known inventory items.",
72806
+ "related": [
72807
+ "inventory_items.query",
72808
+ "inventory_locations.get",
72809
+ "products.get"
72810
+ ],
72811
+ "deleteBoundary": {
72812
+ "resource": "inventory_items",
72813
+ "note": "The specification defines no public DELETE for InventoryItems. A created item cannot be removed through that API.",
72814
+ "proof": "spec-derived"
72815
+ },
72816
+ "untrustedFields": [
72817
+ "bin",
72818
+ "referenceNumber"
72819
+ ],
72820
+ "accountWide": true,
72821
+ "createRequirements": {
72822
+ "requires": {
72823
+ "allOf": [
72824
+ "inventoryLocationID",
72825
+ "productID",
72826
+ "quantityMinimum",
72827
+ "quantityMaximum",
72828
+ "quantityOnHand"
72829
+ ]
72830
+ }
72831
+ }
72832
+ },
72833
+ "compact": null,
72834
+ "status": "tested"
72835
+ },
72836
+ {
72837
+ "id": "inventory_items.get",
72838
+ "resource": "inventory_items",
72839
+ "udfCapable": false,
72840
+ "operation": "get",
72841
+ "kind": "primitive",
72842
+ "endpoint": "GET /V1.0/InventoryItems/{id}",
72843
+ "effect": "read",
72844
+ "flags": [],
72845
+ "dryRun": false,
72846
+ "envelope": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
72847
+ "inputSchema": {
72848
+ "id": {
72849
+ "type": "string | number",
72850
+ "required": true,
72851
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
72852
+ },
72853
+ "opts": {
72854
+ "type": "object",
72855
+ "required": false,
72856
+ "description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
72857
+ "properties": [
72858
+ {
72859
+ "name": "fresh",
72860
+ "type": "boolean",
72861
+ "optional": true
72862
+ }
72863
+ ]
72864
+ }
72865
+ },
72866
+ "inputSchemaStrict": true,
72867
+ "outputSchema": {
72868
+ "type": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
72869
+ "drops": []
72870
+ },
72871
+ "examples": [
72872
+ "await client.inventoryItems.get(7)"
72873
+ ],
72874
+ "permissions": "unknown",
72875
+ "pagination": {
72876
+ "mode": "none"
72877
+ },
72878
+ "resolution": null,
72879
+ "retry": {
72880
+ "preset": "retry-ffb3a9cb"
72881
+ },
72882
+ "errors": {
72883
+ "set": 3
72884
+ },
72885
+ "metadata": {
72886
+ "purpose": "Get one InventoryItem by id.",
72887
+ "usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
72888
+ "preferredWhen": "Preferred when the numeric id is already known.",
72889
+ "related": [
72890
+ "inventory_items.query"
72891
+ ],
72892
+ "args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an inventory_items.query with includeFields.",
72893
+ "untrustedFields": [
72894
+ "bin",
72895
+ "referenceNumber"
72896
+ ]
72897
+ },
72898
+ "compact": null,
72899
+ "status": "tested"
72900
+ },
72901
+ {
72902
+ "id": "inventory_items.getEntityInfo",
72903
+ "resource": "inventory_items",
72904
+ "udfCapable": false,
72905
+ "operation": "getEntityInfo",
72906
+ "kind": "primitive",
72907
+ "endpoint": "GET /V1.0/InventoryItems/entityInformation",
72908
+ "effect": "read",
72909
+ "flags": [],
72910
+ "dryRun": false,
72911
+ "envelope": "EntityInformationResultModel",
72912
+ "inputSchema": {},
72913
+ "inputSchemaStrict": true,
72914
+ "outputSchema": {
72915
+ "type": "EntityInformationResultModel",
72916
+ "drops": []
72917
+ },
72918
+ "examples": [
72919
+ "await client.inventoryItems.getEntityInfo()"
72920
+ ],
72921
+ "permissions": "unknown",
72922
+ "pagination": {
72923
+ "mode": "none"
72924
+ },
72925
+ "resolution": null,
72926
+ "retry": {
72927
+ "preset": "retry-ffb3a9cb"
72928
+ },
72929
+ "errors": {
72930
+ "set": 6
72931
+ },
72932
+ "metadata": {
72933
+ "purpose": "Get the InventoryItem capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
72934
+ "usage": "Unwraps info{}; drives client-side capability checks.",
72935
+ "preferredWhen": null,
72936
+ "related": [
72937
+ "inventory_items.getFieldInfo"
72938
+ ],
72939
+ "untrustedFields": [
72940
+ "bin",
72941
+ "referenceNumber"
72942
+ ]
72943
+ },
72944
+ "compact": null,
72945
+ "status": "tested"
72946
+ },
72947
+ {
72948
+ "id": "inventory_items.getFieldInfo",
72949
+ "resource": "inventory_items",
72950
+ "udfCapable": false,
72951
+ "operation": "getFieldInfo",
72952
+ "kind": "primitive",
72953
+ "endpoint": "GET /V1.0/InventoryItems/entityInformation/fields",
72954
+ "effect": "read",
72955
+ "flags": [],
72956
+ "dryRun": false,
72957
+ "envelope": "FieldInformationResultModel",
72958
+ "inputSchema": {},
72959
+ "inputSchemaStrict": true,
72960
+ "outputSchema": {
72961
+ "type": "FieldInformationResultModel",
72962
+ "drops": []
72963
+ },
72964
+ "examples": [
72965
+ "await client.inventoryItems.getFieldInfo()"
72966
+ ],
72967
+ "permissions": "unknown",
72968
+ "pagination": {
72969
+ "mode": "none"
72970
+ },
72971
+ "resolution": null,
72972
+ "retry": {
72973
+ "preset": "retry-ffb3a9cb"
72974
+ },
72975
+ "errors": {
72976
+ "set": 6
72977
+ },
72978
+ "metadata": {
72979
+ "purpose": "Get the InventoryItem field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
72980
+ "usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
72981
+ "preferredWhen": null,
72982
+ "related": [
72983
+ "inventory_items.getEntityInfo",
72984
+ "inventory_items.getUdfInfo"
72985
+ ],
72986
+ "untrustedFields": [
72987
+ "bin",
72988
+ "referenceNumber"
72989
+ ]
72990
+ },
72991
+ "compact": null,
72992
+ "status": "tested"
72993
+ },
72994
+ {
72995
+ "id": "inventory_items.getUdfInfo",
72996
+ "resource": "inventory_items",
72997
+ "udfCapable": false,
72998
+ "operation": "getUdfInfo",
72999
+ "kind": "primitive",
73000
+ "endpoint": "GET /V1.0/InventoryItems/entityInformation/userDefinedFields",
73001
+ "effect": "read",
73002
+ "flags": [],
73003
+ "dryRun": false,
73004
+ "envelope": "UserDefinedFieldInformationResultModel",
73005
+ "inputSchema": {},
73006
+ "inputSchemaStrict": true,
73007
+ "outputSchema": {
73008
+ "type": "UserDefinedFieldInformationResultModel",
73009
+ "drops": []
73010
+ },
73011
+ "examples": [
73012
+ "await client.inventoryItems.getUdfInfo()"
73013
+ ],
73014
+ "permissions": "unknown",
73015
+ "pagination": {
73016
+ "mode": "none"
73017
+ },
73018
+ "resolution": null,
73019
+ "retry": {
73020
+ "preset": "retry-ffb3a9cb"
73021
+ },
73022
+ "errors": {
73023
+ "set": 6
73024
+ },
73025
+ "metadata": {
73026
+ "purpose": "Get the InventoryItem user-defined-field catalog.",
73027
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
73028
+ "preferredWhen": null,
73029
+ "related": [
73030
+ "inventory_items.getFieldInfo"
73031
+ ],
73032
+ "untrustedFields": [
73033
+ "bin",
73034
+ "referenceNumber"
73035
+ ]
73036
+ },
73037
+ "compact": null,
73038
+ "status": "tested"
73039
+ },
73040
+ {
73041
+ "id": "inventory_items.query",
73042
+ "resource": "inventory_items",
73043
+ "udfCapable": false,
73044
+ "operation": "query",
73045
+ "kind": "primitive",
73046
+ "endpoint": "GET|POST /V1.0/InventoryItems/query",
73047
+ "effect": "read",
73048
+ "flags": [],
73049
+ "dryRun": false,
73050
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
73051
+ "inputSchema": {
73052
+ "params": {
73053
+ "type": "object",
73054
+ "required": false,
73055
+ "description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / no UDFs / 8000 chars. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
73056
+ "properties": [
73057
+ {
73058
+ "name": "filter",
73059
+ "type": "FilterCondition[]",
73060
+ "optional": true
73061
+ },
73062
+ {
73063
+ "name": "limit",
73064
+ "type": "number",
73065
+ "optional": true,
73066
+ "default": 500
73067
+ },
73068
+ {
73069
+ "name": "latest",
73070
+ "type": "number",
73071
+ "optional": true
73072
+ },
73073
+ {
73074
+ "name": "noteChars",
73075
+ "type": "number",
73076
+ "optional": true
73077
+ },
73078
+ {
73079
+ "name": "includeFields",
73080
+ "type": "string[]",
73081
+ "optional": true
73082
+ },
73083
+ {
73084
+ "name": "fieldCheck",
73085
+ "type": "boolean",
73086
+ "optional": true,
73087
+ "default": true
73088
+ },
73089
+ {
73090
+ "name": "names",
73091
+ "type": "boolean",
73092
+ "optional": true
73093
+ },
73094
+ {
73095
+ "name": "via",
73096
+ "type": "\"post\" | \"get\"",
73097
+ "optional": true
73098
+ },
73099
+ {
73100
+ "name": "acknowledgeUnscoped",
73101
+ "type": "boolean",
73102
+ "optional": true
73103
+ },
73104
+ {
73105
+ "name": "walk",
73106
+ "type": "object",
73107
+ "optional": true
73108
+ }
73109
+ ]
73110
+ }
73111
+ },
73112
+ "inputSchemaStrict": true,
73113
+ "outputSchema": {
73114
+ "type": "QueryActionResult[<Model>,<Entity>]",
73115
+ "drops": []
73116
+ },
73117
+ "examples": [
73118
+ "await invoke(client, 'inventory_items.query', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }], limit: 25 }])"
71603
73119
  ],
71604
73120
  "permissions": "unknown",
71605
73121
  "pagination": {
@@ -71617,235 +73133,33 @@
71617
73133
  "preset": "retry-ffb3a9cb"
71618
73134
  },
71619
73135
  "errors": {
71620
- "set": 4
73136
+ "set": 18
71621
73137
  },
71622
73138
  "metadata": {
71623
- "purpose": "Query Contract records with a JSON filter.",
71624
- "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
73139
+ "purpose": "Query InventoryItem records with a JSON filter.",
73140
+ "usage": "Server-side pagination: one call walks the vendor cursor until the limit, end, or 1000-page guard. POST is the default and carries the same QueryModel on continuation. GET mode carries the original search JSON on each GET continuation. queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Continuation cursors stay on this collection. An empty page can still have a next cursor.",
71625
73141
  "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).",
71626
73142
  "related": [
71627
- "contracts.resolve"
73143
+ "inventory_items.get"
71628
73144
  ],
71629
- "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. For a simple text lookup prefer contracts.search. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
73145
+ "args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / no UDFs / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
71630
73146
  "untrustedFields": [
71631
- "UDF1",
71632
- "UDF10",
71633
- "UDF11",
71634
- "UDF12",
71635
- "UDF13",
71636
- "UDF14",
71637
- "UDF15",
71638
- "UDF16",
71639
- "UDF17",
71640
- "UDF18",
71641
- "UDF19",
71642
- "UDF2",
71643
- "UDF20",
71644
- "UDF3",
71645
- "UDF4",
71646
- "UDF5",
71647
- "UDF6",
71648
- "UDF7",
71649
- "UDF8",
71650
- "UDF9",
71651
- "contactName",
71652
- "contractName",
71653
- "description"
73147
+ "bin",
73148
+ "referenceNumber"
71654
73149
  ]
71655
73150
  },
71656
73151
  "compact": null,
71657
73152
  "status": "tested"
71658
73153
  },
71659
73154
  {
71660
- "id": "contracts.resolve",
71661
- "resource": "contracts",
71662
- "udfCapable": true,
71663
- "operation": "resolve",
71664
- "kind": "helper",
71665
- "endpoint": null,
71666
- "effect": "read",
71667
- "flags": [],
71668
- "dryRun": false,
71669
- "envelope": null,
71670
- "inputSchema": {
71671
- "identifier": {
71672
- "type": "string | number",
71673
- "required": true,
71674
- "description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
71675
- },
71676
- "opts": {
71677
- "type": "object",
71678
- "required": false,
71679
- "description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
71680
- "properties": [
71681
- {
71682
- "name": "expand",
71683
- "type": "boolean",
71684
- "optional": true
71685
- }
71686
- ]
71687
- }
71688
- },
71689
- "inputSchemaStrict": true,
71690
- "outputSchema": {
71691
- "type": "ContractSummary",
71692
- "drops": []
71693
- },
71694
- "examples": [
71695
- "await client.contracts.resolve('example-value')"
71696
- ],
71697
- "permissions": "unknown",
71698
- "pagination": {
71699
- "mode": "none"
71700
- },
71701
- "resolution": {
71702
- "basis": "server-filter",
71703
- "maxScanRecords": 500,
71704
- "maxScanPages": 4
71705
- },
71706
- "retry": {
71707
- "preset": "retry-ffb3a9cb"
71708
- },
71709
- "errors": {
71710
- "set": 5
71711
- },
71712
- "metadata": {
71713
- "purpose": "Resolve a contract from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (contractName — exact match only). Returns the Contract record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
71714
- "usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
71715
- "preferredWhen": null,
71716
- "related": [
71717
- "contracts.get"
71718
- ],
71719
- "untrustedFields": [
71720
- "UDF1",
71721
- "UDF10",
71722
- "UDF11",
71723
- "UDF12",
71724
- "UDF13",
71725
- "UDF14",
71726
- "UDF15",
71727
- "UDF16",
71728
- "UDF17",
71729
- "UDF18",
71730
- "UDF19",
71731
- "UDF2",
71732
- "UDF20",
71733
- "UDF3",
71734
- "UDF4",
71735
- "UDF5",
71736
- "UDF6",
71737
- "UDF7",
71738
- "UDF8",
71739
- "UDF9",
71740
- "contactName",
71741
- "contractName",
71742
- "description"
71743
- ]
71744
- },
71745
- "compact": "ContractSummary",
71746
- "status": "tested"
71747
- },
71748
- {
71749
- "id": "contracts.search",
71750
- "resource": "contracts",
71751
- "udfCapable": true,
71752
- "operation": "search",
71753
- "kind": "helper",
71754
- "endpoint": null,
71755
- "effect": "read",
71756
- "flags": [],
71757
- "dryRun": false,
71758
- "envelope": null,
71759
- "inputSchema": {
71760
- "query": {
71761
- "type": "string",
71762
- "required": true,
71763
- "description": "The free text to match (contains) on the resource searchable fields."
71764
- },
71765
- "opts": {
71766
- "type": "object",
71767
- "required": false,
71768
- "description": "SearchOpts — { limit?: number } (1-500, default 25).",
71769
- "properties": [
71770
- {
71771
- "name": "limit",
71772
- "type": "number",
71773
- "optional": true
71774
- }
71775
- ]
71776
- }
71777
- },
71778
- "inputSchemaStrict": true,
71779
- "outputSchema": {
71780
- "type": "ContractSummary",
71781
- "drops": []
71782
- },
71783
- "examples": [
71784
- "await client.contracts.search('example')"
71785
- ],
71786
- "permissions": "unknown",
71787
- "pagination": {
71788
- "mode": "none"
71789
- },
71790
- "resolution": {
71791
- "basis": "server-filter",
71792
- "maxScanRecords": 500,
71793
- "maxScanPages": 4
71794
- },
71795
- "retry": {
71796
- "preset": "retry-ffb3a9cb"
71797
- },
71798
- "errors": {
71799
- "set": 5
71800
- },
71801
- "metadata": {
71802
- "purpose": "Search contract records by text (contains on the searchable fields).",
71803
- "usage": "Vendor exposes no free-text search; this is a bounded contains filter: contractName only (contains). limit defaults to 25, max 500.",
71804
- "preferredWhen": null,
71805
- "related": [
71806
- "contracts.resolve",
71807
- "contracts.query"
71808
- ],
71809
- "untrustedFields": [
71810
- "UDF1",
71811
- "UDF10",
71812
- "UDF11",
71813
- "UDF12",
71814
- "UDF13",
71815
- "UDF14",
71816
- "UDF15",
71817
- "UDF16",
71818
- "UDF17",
71819
- "UDF18",
71820
- "UDF19",
71821
- "UDF2",
71822
- "UDF20",
71823
- "UDF3",
71824
- "UDF4",
71825
- "UDF5",
71826
- "UDF6",
71827
- "UDF7",
71828
- "UDF8",
71829
- "UDF9",
71830
- "contactName",
71831
- "contractName",
71832
- "description"
71833
- ]
71834
- },
71835
- "compact": "ContractSummary",
71836
- "status": "tested"
71837
- },
71838
- {
71839
- "id": "contracts.update",
71840
- "resource": "contracts",
71841
- "udfCapable": true,
73155
+ "id": "inventory_items.update",
73156
+ "resource": "inventory_items",
73157
+ "udfCapable": false,
71842
73158
  "operation": "update",
71843
73159
  "kind": "primitive",
71844
- "endpoint": "PUT|PATCH /V1.0/Contracts",
73160
+ "endpoint": "PATCH /V1.0/InventoryItems",
71845
73161
  "effect": "write",
71846
- "flags": [
71847
- "idempotent"
71848
- ],
73162
+ "flags": [],
71849
73163
  "dryRun": true,
71850
73164
  "envelope": "OperationResultModel",
71851
73165
  "inputSchema": {
@@ -71866,7 +73180,7 @@
71866
73180
  "drops": []
71867
73181
  },
71868
73182
  "examples": [
71869
- "await client.contracts.update('example-value', { contractName: 'example' }, { dryRun: true })"
73183
+ "await client.inventoryItems.update(7, { bin: 'A1' }, { dryRun: true })"
71870
73184
  ],
71871
73185
  "permissions": "unknown",
71872
73186
  "pagination": {
@@ -71874,47 +73188,24 @@
71874
73188
  },
71875
73189
  "resolution": null,
71876
73190
  "retry": {
71877
- "preset": "retry-1849870d"
73191
+ "preset": "retry-c5657094"
71878
73192
  },
71879
73193
  "errors": {
71880
- "set": 1
73194
+ "set": 17
71881
73195
  },
71882
73196
  "metadata": {
71883
- "purpose": "Update a contract.",
71884
- "usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) 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).",
71885
- "preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
73197
+ "purpose": "Update writable inventory item fields with collection PATCH.",
73198
+ "usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. The ID is supplied separately and travels in the PATCH body. Product and location are immutable. Min/max changes use fresh current bounds. On-hand changes require known picked and reserved counters and a fresh nonserialized product. A fresh preflight is not atomic and no timestamp is documented. No replacing PUT fallback or maintenance replay is issued.",
73199
+ "preferredWhen": "Use with a known item ID and only the writable fields that should change.",
71886
73200
  "related": [
71887
- "contracts.get"
73201
+ "inventory_items.get",
73202
+ "products.get"
71888
73203
  ],
71889
- "collectionUpdate": true,
71890
73204
  "untrustedFields": [
71891
- "UDF1",
71892
- "UDF10",
71893
- "UDF11",
71894
- "UDF12",
71895
- "UDF13",
71896
- "UDF14",
71897
- "UDF15",
71898
- "UDF16",
71899
- "UDF17",
71900
- "UDF18",
71901
- "UDF19",
71902
- "UDF2",
71903
- "UDF20",
71904
- "UDF3",
71905
- "UDF4",
71906
- "UDF5",
71907
- "UDF6",
71908
- "UDF7",
71909
- "UDF8",
71910
- "UDF9",
71911
- "contactName",
71912
- "contractName",
71913
- "description"
73205
+ "bin",
73206
+ "referenceNumber"
71914
73207
  ],
71915
- "writeQuirks": {
71916
- "dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
71917
- }
73208
+ "accountWide": true
71918
73209
  },
71919
73210
  "compact": null,
71920
73211
  "status": "tested"
@@ -72018,7 +73309,7 @@
72018
73309
  "preset": "retry-c5657094"
72019
73310
  },
72020
73311
  "errors": {
72021
- "set": 15
73312
+ "set": 19
72022
73313
  },
72023
73314
  "metadata": {
72024
73315
  "purpose": "Create an inventory location.",
@@ -72344,7 +73635,7 @@
72344
73635
  "preset": "retry-ffb3a9cb"
72345
73636
  },
72346
73637
  "errors": {
72347
- "set": 16
73638
+ "set": 20
72348
73639
  },
72349
73640
  "metadata": {
72350
73641
  "purpose": "Query InventoryLocation records with a JSON filter.",
@@ -72403,7 +73694,7 @@
72403
73694
  "preset": "retry-c5657094"
72404
73695
  },
72405
73696
  "errors": {
72406
- "set": 17
73697
+ "set": 21
72407
73698
  },
72408
73699
  "metadata": {
72409
73700
  "purpose": "Update an inventory location.",
@@ -77673,7 +78964,7 @@
77673
78964
  "preset": "retry-ffb3a9cb"
77674
78965
  },
77675
78966
  "errors": {
77676
- "set": 13
78967
+ "set": 15
77677
78968
  },
77678
78969
  "metadata": {
77679
78970
  "purpose": "Get a project with its primary context records in one call.",
@@ -80280,7 +81571,7 @@
80280
81571
  "preset": "retry-ffb3a9cb"
80281
81572
  },
80282
81573
  "errors": {
80283
- "set": 10
81574
+ "set": 12
80284
81575
  },
80285
81576
  "metadata": {
80286
81577
  "purpose": "Get a quote with its line items in a single call — the items part is the bounded quoteID-filtered query.",
@@ -81224,7 +82515,7 @@
81224
82515
  "preset": "retry-c5657094"
81225
82516
  },
81226
82517
  "errors": {
81227
- "set": 15
82518
+ "set": 19
81228
82519
  },
81229
82520
  "metadata": {
81230
82521
  "purpose": "Create an attachment under a task.",
@@ -81296,7 +82587,7 @@
81296
82587
  "preset": "retry-1849870d"
81297
82588
  },
81298
82589
  "errors": {
81299
- "set": 18
82590
+ "set": 22
81300
82591
  },
81301
82592
  "metadata": {
81302
82593
  "purpose": "Delete an attachment under a task.",
@@ -81567,7 +82858,7 @@
81567
82858
  "preset": "retry-ffb3a9cb"
81568
82859
  },
81569
82860
  "errors": {
81570
- "set": 16
82861
+ "set": 20
81571
82862
  },
81572
82863
  "metadata": {
81573
82864
  "purpose": "Query TaskAttachment records with a JSON filter.",
@@ -90335,7 +91626,7 @@
90335
91626
  "preset": "retry-6980a375"
90336
91627
  },
90337
91628
  "errors": {
90338
- "set": 19
91629
+ "set": 23
90339
91630
  },
90340
91631
  "metadata": {
90341
91632
  "purpose": "Move a ticket to a target status in ONE op — the node validates targetStatus against the tenant's LIVE status picklist (entity metadata; vendor rejection is the fallback when the metadata is unavailable) + the live-discovered per-status required-field map and fills the proven-safe defaults itself (the vendor 500s when a target status has unsatisfied field requirements; the MCP LLM has no way to know the map).",
@@ -90740,7 +92031,7 @@
90740
92031
  "preset": "retry-ffb3a9cb"
90741
92032
  },
90742
92033
  "errors": {
90743
- "set": 20
92034
+ "set": 24
90744
92035
  },
90745
92036
  "metadata": {
90746
92037
  "purpose": "List the tickets a resource is assigned to — as primary owner, as a secondary resource, or both — de-duplicated, with the four reconciling counts and an optional open-only filter that uses the tenant's own closed-status set.",
@@ -90871,7 +92162,7 @@
90871
92162
  "preset": "retry-ffb3a9cb"
90872
92163
  },
90873
92164
  "errors": {
90874
- "set": 14
92165
+ "set": 16
90875
92166
  },
90876
92167
  "metadata": {
90877
92168
  "purpose": "Get the full context of one ticket in a single call: the ticket, its company, contact, assigned resource and project, plus its notes, time entries, attachment metadata and (opt-in) histories — every part separately reported.",
@@ -91076,7 +92367,7 @@
91076
92367
  "preset": "retry-ffb3a9cb"
91077
92368
  },
91078
92369
  "errors": {
91079
- "set": 13
92370
+ "set": 15
91080
92371
  },
91081
92372
  "metadata": {
91082
92373
  "purpose": "Get a ticket with its primary context records in one call.",
@@ -91395,7 +92686,7 @@
91395
92686
  "preset": "retry-ffb3a9cb"
91396
92687
  },
91397
92688
  "errors": {
91398
- "set": 14
92689
+ "set": 16
91399
92690
  },
91400
92691
  "metadata": {
91401
92692
  "purpose": "Get the full Line of Business chain for one ticket in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
@@ -91833,7 +93124,7 @@
91833
93124
  "preset": "retry-ffb3a9cb"
91834
93125
  },
91835
93126
  "errors": {
91836
- "set": 13
93127
+ "set": 15
91837
93128
  },
91838
93129
  "metadata": {
91839
93130
  "purpose": "Run the SLA health check for a ticket (numeric ticket id).",
@@ -91930,7 +93221,7 @@
91930
93221
  "preset": "retry-ffb3a9cb"
91931
93222
  },
91932
93223
  "errors": {
91933
- "set": 21
93224
+ "set": 25
91934
93225
  },
91935
93226
  "metadata": {
91936
93227
  "purpose": "Report the ticket status picklist and the ids this SDK treats as CLOSED for the caller's tenant, with the provenance of that set (read from the tenant's picklist, or the documented assumed fallback).",
@@ -92028,7 +93319,7 @@
92028
93319
  "preset": "retry-ffb3a9cb"
92029
93320
  },
92030
93321
  "errors": {
92031
- "set": 13
93322
+ "set": 15
92032
93323
  },
92033
93324
  "metadata": {
92034
93325
  "purpose": "Get a one-call summary of a ticket (numeric ticket id).",
@@ -92138,7 +93429,7 @@
92138
93429
  "preset": "retry-ffb3a9cb"
92139
93430
  },
92140
93431
  "errors": {
92141
- "set": 13
93432
+ "set": 15
92142
93433
  },
92143
93434
  "metadata": {
92144
93435
  "purpose": "Get the event timeline of a ticket (numeric ticket id).",
@@ -92289,8 +93580,8 @@
92289
93580
  ]
92290
93581
  },
92291
93582
  "operations": {
92292
- "planHash": "2f78ad6e25fd96f024dfc749c3c9d1b8dbf52d8a23e097bd5046605a9975787c",
92293
- "builtAt": "2026-11-21T03:40:52.140Z",
93583
+ "planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
93584
+ "builtAt": "2026-11-21T07:49:35.531Z",
92294
93585
  "records": [
92295
93586
  {
92296
93587
  "id": "operations.aggregate",
@@ -92373,7 +93664,7 @@
92373
93664
  "preset": "retry-ffb3a9cb"
92374
93665
  },
92375
93666
  "errors": {
92376
- "set": 22
93667
+ "set": 26
92377
93668
  },
92378
93669
  "metadata": {
92379
93670
  "purpose": "Fold any query surface into groups/sums/totals in one bounded call — or count it with the vendor count endpoint when no folding is needed — with blind-surface and truncation honesty (caps documented: the walk scans at most 2500 rows and top keeps at most 100 groups — a truncated aggregate is a PARTIAL answer, never a tenant-wide total); date fields bucket via the closed groupBy suffix <field>@month | @week | @year (ISO labels, UTC-anchored). Use it for totals, sums, counts and hours per ticket, resource, company, contract or month (group by any field), e.g. time entries hours grouped by ticket and resource",
@@ -92407,6 +93698,7 @@
92407
93698
  "UDF8",
92408
93699
  "UDF9",
92409
93700
  "action",
93701
+ "additionalAddressInfo",
92410
93702
  "additionalBillToAddressInformation",
92411
93703
  "additionalShipToAddressInformation",
92412
93704
  "alertText",
@@ -92427,6 +93719,7 @@
92427
93719
  "contactName",
92428
93720
  "contractName",
92429
93721
  "costType",
93722
+ "country",
92430
93723
  "coveredByBlockRetainerContractLabel",
92431
93724
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
92432
93725
  "data",
@@ -92505,6 +93798,7 @@
92505
93798
  "templateName",
92506
93799
  "ticketTitle",
92507
93800
  "timeFormat",
93801
+ "timeZone",
92508
93802
  "title",
92509
93803
  "travelAvailabilityPct",
92510
93804
  "userName",
@@ -92581,7 +93875,7 @@
92581
93875
  "preset": "retry-ffb3a9cb"
92582
93876
  },
92583
93877
  "errors": {
92584
- "set": 23
93878
+ "set": 27
92585
93879
  },
92586
93880
  "metadata": {
92587
93881
  "purpose": "Accounts-receivable aging at a point in time, in one budgeted call: open invoices per company bucketed by days past due (current, 1-30, 31-60, 61-90, over 90, no due date), with totals per currency.",
@@ -92647,7 +93941,7 @@
92647
93941
  "preset": "retry-ffb3a9cb"
92648
93942
  },
92649
93943
  "errors": {
92650
- "set": 24
93944
+ "set": 28
92651
93945
  },
92652
93946
  "metadata": {
92653
93947
  "purpose": "Read static creation requirements, prior validation findings and unproven input guidance. This is not a live test of current-tenant capability, inventory or permissions.",
@@ -92698,7 +93992,7 @@
92698
93992
  "preset": "retry-ffb3a9cb"
92699
93993
  },
92700
93994
  "errors": {
92701
- "set": 14
93995
+ "set": 16
92702
93996
  },
92703
93997
  "metadata": {
92704
93998
  "purpose": "Resolve resource ids to display names in one opt-in call: per-id resources.get reads (never an id-in query) with blind-marked rows for ids the API user cannot resolve served from the read cache (each distinct id fetched at most once per cache lifetime).",
@@ -92750,7 +94044,7 @@
92750
94044
  "preset": "retry-ffb3a9cb"
92751
94045
  },
92752
94046
  "errors": {
92753
- "set": 14
94047
+ "set": 16
92754
94048
  },
92755
94049
  "metadata": {
92756
94050
  "purpose": "Fetch up to 500 single records by id across mixed resources in one call (query-first chunked id-in reads with a per-id get fallback), with per-item typed results.",
@@ -92784,6 +94078,7 @@
92784
94078
  "UDF8",
92785
94079
  "UDF9",
92786
94080
  "action",
94081
+ "additionalAddressInfo",
92787
94082
  "additionalBillToAddressInformation",
92788
94083
  "additionalShipToAddressInformation",
92789
94084
  "alertText",
@@ -92804,6 +94099,7 @@
92804
94099
  "contactName",
92805
94100
  "contractName",
92806
94101
  "costType",
94102
+ "country",
92807
94103
  "coveredByBlockRetainerContractLabel",
92808
94104
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
92809
94105
  "data",
@@ -92882,6 +94178,7 @@
92882
94178
  "templateName",
92883
94179
  "ticketTitle",
92884
94180
  "timeFormat",
94181
+ "timeZone",
92885
94182
  "title",
92886
94183
  "travelAvailabilityPct",
92887
94184
  "userName",
@@ -92970,7 +94267,7 @@
92970
94267
  "preset": "retry-ffb3a9cb"
92971
94268
  },
92972
94269
  "errors": {
92973
- "set": 25
94270
+ "set": 29
92974
94271
  },
92975
94272
  "metadata": {
92976
94273
  "purpose": "Fetch the LIVE vendor field catalog for the named resources in one bounded read call: which fields exist, which are required, types, maxLength, read-only, queryable, picklist-ness — the on-demand refresh for the point-in-time pins (operations.createGuidance, the zoneFacts) when the vendor has moved since they were verified. The wire cost (resources × include) is refused pre-request above the cap, never truncated; with the opt-in fieldCache configured, repeat reads inside the TTL cost no wire. It reports picklist-ness as a flag (isPickList) and picklist field NAMES (picklistFields); with the opt-in labels: true the projected picklist rows carry the vendor's exposed picklist VALUES (labels next to each value), and without it the op serves no VALUES. A picklist VALUE the vendor does not expose to this API user is not resolvable from this catalog.",
@@ -93067,7 +94364,7 @@
93067
94364
  "preset": "retry-ffb3a9cb"
93068
94365
  },
93069
94366
  "errors": {
93070
- "set": 23
94367
+ "set": 27
93071
94368
  },
93072
94369
  "metadata": {
93073
94370
  "purpose": "Non-chargeable work in one budgeted call: non-billable and contract-covered billing items (value, labour hours, lines) per company, contract or contract type, posted or invoiced or not.",
@@ -93184,7 +94481,7 @@
93184
94481
  "preset": "retry-ffb3a9cb"
93185
94482
  },
93186
94483
  "errors": {
93187
- "set": 26
94484
+ "set": 30
93188
94485
  },
93189
94486
  "metadata": {
93190
94487
  "purpose": "Contract profit and margin grouped by contract, company, contract type, vertical or month over a window, in one budgeted call: a contracts.profitability fan-out with totals and per-contract coverage gaps.",
@@ -93274,7 +94571,7 @@
93274
94571
  "preset": "retry-ffb3a9cb"
93275
94572
  },
93276
94573
  "errors": {
93277
- "set": 23
94574
+ "set": 27
93278
94575
  },
93279
94576
  "metadata": {
93280
94577
  "purpose": "Monthly recurring revenue at a point in time per company, in one budgeted call: contract services, subscriptions and the month's contract charges (usage billing, counted as recurring revenue) reported apart, plus the contracts ending soon.",
@@ -93329,7 +94626,7 @@
93329
94626
  "preset": "retry-ffb3a9cb"
93330
94627
  },
93331
94628
  "errors": {
93332
- "set": 24
94629
+ "set": 28
93333
94630
  },
93334
94631
  "metadata": {
93335
94632
  "purpose": "Describe a resource’s SDK-covered parent/child operations, lookup keys and static create guidance without a vendor call. Current-user visibility and tenant inventory require live reads.",
@@ -93437,6 +94734,7 @@
93437
94734
  "UDF8",
93438
94735
  "UDF9",
93439
94736
  "action",
94737
+ "additionalAddressInfo",
93440
94738
  "additionalBillToAddressInformation",
93441
94739
  "additionalShipToAddressInformation",
93442
94740
  "alertText",
@@ -93457,6 +94755,7 @@
93457
94755
  "contactName",
93458
94756
  "contractName",
93459
94757
  "costType",
94758
+ "country",
93460
94759
  "coveredByBlockRetainerContractLabel",
93461
94760
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
93462
94761
  "data",
@@ -93535,6 +94834,7 @@
93535
94834
  "templateName",
93536
94835
  "ticketTitle",
93537
94836
  "timeFormat",
94837
+ "timeZone",
93538
94838
  "title",
93539
94839
  "travelAvailabilityPct",
93540
94840
  "userName",
@@ -93746,7 +95046,7 @@
93746
95046
  "preset": "retry-ffb3a9cb"
93747
95047
  },
93748
95048
  "errors": {
93749
- "set": 23
95049
+ "set": 27
93750
95050
  },
93751
95051
  "metadata": {
93752
95052
  "purpose": "Total revenue grouped by account vertical, contract type, company, contract, month or line of business over an invoice-date window, in one budgeted call with totals, excluded buckets, a reconciliation and optional non-chargeable work.",
@@ -93806,7 +95106,7 @@
93806
95106
  "preset": "retry-ffb3a9cb"
93807
95107
  },
93808
95108
  "errors": {
93809
- "set": 27
95109
+ "set": 31
93810
95110
  },
93811
95111
  "metadata": {
93812
95112
  "purpose": "Fence the vendor free text of a raw SDK read result in the untrusted-content markers, using the operation's own registry record as the field authority.",
@@ -93913,6 +95213,7 @@
93913
95213
  "UDF8",
93914
95214
  "UDF9",
93915
95215
  "action",
95216
+ "additionalAddressInfo",
93916
95217
  "additionalBillToAddressInformation",
93917
95218
  "additionalShipToAddressInformation",
93918
95219
  "alertText",
@@ -93933,6 +95234,7 @@
93933
95234
  "contactName",
93934
95235
  "contractName",
93935
95236
  "costType",
95237
+ "country",
93936
95238
  "coveredByBlockRetainerContractLabel",
93937
95239
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
93938
95240
  "data",
@@ -94011,6 +95313,7 @@
94011
95313
  "templateName",
94012
95314
  "ticketTitle",
94013
95315
  "timeFormat",
95316
+ "timeZone",
94014
95317
  "title",
94015
95318
  "travelAvailabilityPct",
94016
95319
  "userName",
@@ -94079,7 +95382,7 @@
94079
95382
  "preset": "retry-ffb3a9cb"
94080
95383
  },
94081
95384
  "errors": {
94082
- "set": 27
95385
+ "set": 31
94083
95386
  },
94084
95387
  "metadata": {
94085
95388
  "purpose": "Build a clickable Autotask UI deep link for a record in one ZERO-wire call, e.g. for the time entry or ticket a response is about.",
@@ -94170,7 +95473,7 @@
94170
95473
  "preset": "retry-ffb3a9cb"
94171
95474
  },
94172
95475
  "errors": {
94173
- "set": 28
95476
+ "set": 32
94174
95477
  },
94175
95478
  "metadata": {
94176
95479
  "purpose": "Work in progress in one budgeted call: billable time entries no billing item references yet (unposted), in hours, per company, resource or contract type, split approved / unapproved where the tenant records approval.",
@@ -94347,6 +95650,36 @@
94347
95650
  "RESPONSE_REJECTED",
94348
95651
  "QUERY_TOO_LONG"
94349
95652
  ],
95653
+ [
95654
+ "BAD_REQUEST",
95655
+ "CONFIG_ERROR",
95656
+ "NETWORK_ERROR",
95657
+ "UNAUTHORIZED",
95658
+ "FORBIDDEN",
95659
+ "RATE_LIMITED",
95660
+ "TIMEOUT",
95661
+ "SERVER_ERROR",
95662
+ "INVALID_RESPONSE",
95663
+ "ABORTED",
95664
+ "RESPONSE_TOO_LARGE",
95665
+ "REDIRECT_BLOCKED"
95666
+ ],
95667
+ [
95668
+ "BAD_REQUEST",
95669
+ "CONFIG_ERROR",
95670
+ "NETWORK_ERROR",
95671
+ "UNAUTHORIZED",
95672
+ "FORBIDDEN",
95673
+ "RATE_LIMITED",
95674
+ "TIMEOUT",
95675
+ "SERVER_ERROR",
95676
+ "INVALID_RESPONSE",
95677
+ "ABORTED",
95678
+ "RESPONSE_TOO_LARGE",
95679
+ "REDIRECT_BLOCKED",
95680
+ "RESPONSE_REJECTED",
95681
+ "SCOPE_REQUIRED"
95682
+ ],
94350
95683
  [
94351
95684
  "BAD_REQUEST",
94352
95685
  "CONFIG_ERROR",
@@ -94448,6 +95781,40 @@
94448
95781
  "RESPONSE_TOO_LARGE",
94449
95782
  "REDIRECT_BLOCKED"
94450
95783
  ],
95784
+ [
95785
+ "BAD_REQUEST",
95786
+ "CONFIG_ERROR",
95787
+ "NETWORK_ERROR",
95788
+ "UNAUTHORIZED",
95789
+ "RATE_LIMITED",
95790
+ "VALIDATION_FAILED",
95791
+ "CONFLICT",
95792
+ "TIMEOUT",
95793
+ "SERVER_ERROR",
95794
+ "INVALID_RESPONSE",
95795
+ "ABORTED",
95796
+ "RESPONSE_TOO_LARGE",
95797
+ "REDIRECT_BLOCKED",
95798
+ "FORBIDDEN",
95799
+ "NOT_FOUND",
95800
+ "MAINTENANCE"
95801
+ ],
95802
+ [
95803
+ "BAD_REQUEST",
95804
+ "CONFIG_ERROR",
95805
+ "NETWORK_ERROR",
95806
+ "UNAUTHORIZED",
95807
+ "RATE_LIMITED",
95808
+ "TIMEOUT",
95809
+ "SERVER_ERROR",
95810
+ "INVALID_RESPONSE",
95811
+ "ABORTED",
95812
+ "RESPONSE_TOO_LARGE",
95813
+ "REDIRECT_BLOCKED",
95814
+ "SCOPE_REQUIRED",
95815
+ "FORBIDDEN",
95816
+ "RESPONSE_REJECTED"
95817
+ ],
94451
95818
  [
94452
95819
  "BAD_REQUEST",
94453
95820
  "CONFIG_ERROR",