@augno/sdk 0.1.9 → 0.7.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 (670) hide show
  1. package/CHANGELOG.md +4 -9
  2. package/README.md +27 -0
  3. package/api-promise.d.mts +0 -1
  4. package/api-promise.d.mts.map +1 -1
  5. package/api-promise.d.ts +0 -1
  6. package/api-promise.d.ts.map +1 -1
  7. package/api-promise.mjs +0 -1
  8. package/api-promise.mjs.map +1 -1
  9. package/client.d.mts +4 -1
  10. package/client.d.mts.map +1 -1
  11. package/client.d.ts +4 -1
  12. package/client.d.ts.map +1 -1
  13. package/client.js +9 -1
  14. package/client.js.map +1 -1
  15. package/client.mjs +9 -1
  16. package/client.mjs.map +1 -1
  17. package/core/api-promise.d.mts.map +1 -1
  18. package/core/api-promise.d.ts.map +1 -1
  19. package/core/api-promise.mjs.map +1 -1
  20. package/core/error.mjs.map +1 -1
  21. package/core/resource.d.mts.map +1 -1
  22. package/core/resource.d.ts.map +1 -1
  23. package/core/uploads.d.mts.map +1 -1
  24. package/core/uploads.d.ts.map +1 -1
  25. package/core/uploads.mjs.map +1 -1
  26. package/error.d.mts +0 -1
  27. package/error.d.mts.map +1 -1
  28. package/error.d.ts +0 -1
  29. package/error.d.ts.map +1 -1
  30. package/error.mjs +0 -1
  31. package/error.mjs.map +1 -1
  32. package/index.d.mts.map +1 -1
  33. package/index.d.ts.map +1 -1
  34. package/index.mjs.map +1 -1
  35. package/internal/headers.mjs.map +1 -1
  36. package/internal/parse.d.mts.map +1 -1
  37. package/internal/parse.d.ts.map +1 -1
  38. package/internal/parse.mjs.map +1 -1
  39. package/internal/qs/formats.d.mts.map +1 -1
  40. package/internal/qs/formats.d.ts.map +1 -1
  41. package/internal/qs/index.d.mts +2 -2
  42. package/internal/qs/index.d.mts.map +1 -1
  43. package/internal/qs/index.d.ts +2 -2
  44. package/internal/qs/index.d.ts.map +1 -1
  45. package/internal/qs/index.mjs.map +1 -1
  46. package/internal/qs/stringify.d.mts.map +1 -1
  47. package/internal/qs/stringify.d.ts.map +1 -1
  48. package/internal/qs/stringify.mjs.map +1 -1
  49. package/internal/qs/utils.d.mts.map +1 -1
  50. package/internal/qs/utils.d.ts.map +1 -1
  51. package/internal/qs/utils.mjs.map +1 -1
  52. package/internal/request-options.d.mts.map +1 -1
  53. package/internal/request-options.d.ts.map +1 -1
  54. package/internal/shims.d.mts +0 -6
  55. package/internal/shims.d.mts.map +1 -1
  56. package/internal/shims.d.ts +0 -6
  57. package/internal/shims.d.ts.map +1 -1
  58. package/internal/to-file.d.mts.map +1 -1
  59. package/internal/to-file.d.ts.map +1 -1
  60. package/internal/to-file.mjs.map +1 -1
  61. package/internal/types.d.mts +4 -4
  62. package/internal/types.d.mts.map +1 -1
  63. package/internal/types.d.ts +4 -4
  64. package/internal/types.d.ts.map +1 -1
  65. package/internal/uploads.d.mts.map +1 -1
  66. package/internal/uploads.d.ts.map +1 -1
  67. package/internal/uploads.mjs.map +1 -1
  68. package/internal/utils/base64.mjs.map +1 -1
  69. package/internal/utils/log.d.mts.map +1 -1
  70. package/internal/utils/log.d.ts.map +1 -1
  71. package/internal/utils/log.mjs.map +1 -1
  72. package/internal/utils/path.mjs.map +1 -1
  73. package/internal/utils/query.mjs.map +1 -1
  74. package/internal/utils/values.mjs.map +1 -1
  75. package/internal/utils.d.mts.map +1 -1
  76. package/internal/utils.d.ts.map +1 -1
  77. package/internal/utils.mjs.map +1 -1
  78. package/package.json +3 -3
  79. package/resource.d.mts +0 -1
  80. package/resource.d.mts.map +1 -1
  81. package/resource.d.ts +0 -1
  82. package/resource.d.ts.map +1 -1
  83. package/resource.mjs +0 -1
  84. package/resource.mjs.map +1 -1
  85. package/resources/auth/api-keys/actions.d.mts +26 -5
  86. package/resources/auth/api-keys/actions.d.mts.map +1 -1
  87. package/resources/auth/api-keys/actions.d.ts +26 -5
  88. package/resources/auth/api-keys/actions.d.ts.map +1 -1
  89. package/resources/auth/api-keys/actions.js +4 -1
  90. package/resources/auth/api-keys/actions.js.map +1 -1
  91. package/resources/auth/api-keys/actions.mjs +4 -1
  92. package/resources/auth/api-keys/actions.mjs.map +1 -1
  93. package/resources/auth/api-keys/api-keys.d.mts +134 -70
  94. package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
  95. package/resources/auth/api-keys/api-keys.d.ts +134 -70
  96. package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
  97. package/resources/auth/api-keys/api-keys.js +24 -22
  98. package/resources/auth/api-keys/api-keys.js.map +1 -1
  99. package/resources/auth/api-keys/api-keys.mjs +24 -22
  100. package/resources/auth/api-keys/api-keys.mjs.map +1 -1
  101. package/resources/auth/api-keys/index.d.mts +1 -1
  102. package/resources/auth/api-keys/index.d.mts.map +1 -1
  103. package/resources/auth/api-keys/index.d.ts +1 -1
  104. package/resources/auth/api-keys/index.d.ts.map +1 -1
  105. package/resources/auth/api-keys/index.mjs.map +1 -1
  106. package/resources/auth/api-keys.d.mts.map +1 -1
  107. package/resources/auth/api-keys.d.ts.map +1 -1
  108. package/resources/auth/api-keys.mjs.map +1 -1
  109. package/resources/auth/auth.d.mts +1 -1
  110. package/resources/auth/auth.d.mts.map +1 -1
  111. package/resources/auth/auth.d.ts +1 -1
  112. package/resources/auth/auth.d.ts.map +1 -1
  113. package/resources/auth/auth.mjs.map +1 -1
  114. package/resources/auth/index.d.mts +1 -1
  115. package/resources/auth/index.d.mts.map +1 -1
  116. package/resources/auth/index.d.ts +1 -1
  117. package/resources/auth/index.d.ts.map +1 -1
  118. package/resources/auth/index.mjs.map +1 -1
  119. package/resources/auth.d.mts.map +1 -1
  120. package/resources/auth.d.ts.map +1 -1
  121. package/resources/auth.mjs.map +1 -1
  122. package/resources/catalog/catalog.d.mts +9 -9
  123. package/resources/catalog/catalog.d.mts.map +1 -1
  124. package/resources/catalog/catalog.d.ts +9 -9
  125. package/resources/catalog/catalog.d.ts.map +1 -1
  126. package/resources/catalog/catalog.mjs.map +1 -1
  127. package/resources/catalog/index.d.mts +9 -9
  128. package/resources/catalog/index.d.mts.map +1 -1
  129. package/resources/catalog/index.d.ts +9 -9
  130. package/resources/catalog/index.d.ts.map +1 -1
  131. package/resources/catalog/index.mjs.map +1 -1
  132. package/resources/catalog/item-categories/index.d.mts +1 -1
  133. package/resources/catalog/item-categories/index.d.mts.map +1 -1
  134. package/resources/catalog/item-categories/index.d.ts +1 -1
  135. package/resources/catalog/item-categories/index.d.ts.map +1 -1
  136. package/resources/catalog/item-categories/index.mjs.map +1 -1
  137. package/resources/catalog/item-categories/item-categories.d.mts +95 -65
  138. package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
  139. package/resources/catalog/item-categories/item-categories.d.ts +95 -65
  140. package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
  141. package/resources/catalog/item-categories/item-categories.js +38 -30
  142. package/resources/catalog/item-categories/item-categories.js.map +1 -1
  143. package/resources/catalog/item-categories/item-categories.mjs +38 -30
  144. package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
  145. package/resources/catalog/item-categories/properties.d.mts +9 -4
  146. package/resources/catalog/item-categories/properties.d.mts.map +1 -1
  147. package/resources/catalog/item-categories/properties.d.ts +9 -4
  148. package/resources/catalog/item-categories/properties.d.ts.map +1 -1
  149. package/resources/catalog/item-categories/properties.js +9 -4
  150. package/resources/catalog/item-categories/properties.js.map +1 -1
  151. package/resources/catalog/item-categories/properties.mjs +9 -4
  152. package/resources/catalog/item-categories/properties.mjs.map +1 -1
  153. package/resources/catalog/item-categories.d.mts.map +1 -1
  154. package/resources/catalog/item-categories.d.ts.map +1 -1
  155. package/resources/catalog/item-categories.mjs.map +1 -1
  156. package/resources/catalog/items/attributes.d.mts +3 -2
  157. package/resources/catalog/items/attributes.d.mts.map +1 -1
  158. package/resources/catalog/items/attributes.d.ts +3 -2
  159. package/resources/catalog/items/attributes.d.ts.map +1 -1
  160. package/resources/catalog/items/attributes.js +3 -2
  161. package/resources/catalog/items/attributes.js.map +1 -1
  162. package/resources/catalog/items/attributes.mjs +3 -2
  163. package/resources/catalog/items/attributes.mjs.map +1 -1
  164. package/resources/catalog/items/index.d.mts +1 -1
  165. package/resources/catalog/items/index.d.mts.map +1 -1
  166. package/resources/catalog/items/index.d.ts +1 -1
  167. package/resources/catalog/items/index.d.ts.map +1 -1
  168. package/resources/catalog/items/index.mjs.map +1 -1
  169. package/resources/catalog/items/items.d.mts +88 -52
  170. package/resources/catalog/items/items.d.mts.map +1 -1
  171. package/resources/catalog/items/items.d.ts +88 -52
  172. package/resources/catalog/items/items.d.ts.map +1 -1
  173. package/resources/catalog/items/items.js +24 -21
  174. package/resources/catalog/items/items.js.map +1 -1
  175. package/resources/catalog/items/items.mjs +24 -21
  176. package/resources/catalog/items/items.mjs.map +1 -1
  177. package/resources/catalog/items.d.mts.map +1 -1
  178. package/resources/catalog/items.d.ts.map +1 -1
  179. package/resources/catalog/items.mjs.map +1 -1
  180. package/resources/catalog/materials.d.mts +134 -87
  181. package/resources/catalog/materials.d.mts.map +1 -1
  182. package/resources/catalog/materials.d.ts +134 -87
  183. package/resources/catalog/materials.d.ts.map +1 -1
  184. package/resources/catalog/materials.js +29 -19
  185. package/resources/catalog/materials.js.map +1 -1
  186. package/resources/catalog/materials.mjs +29 -19
  187. package/resources/catalog/materials.mjs.map +1 -1
  188. package/resources/catalog/parts.d.mts +127 -74
  189. package/resources/catalog/parts.d.mts.map +1 -1
  190. package/resources/catalog/parts.d.ts +127 -74
  191. package/resources/catalog/parts.d.ts.map +1 -1
  192. package/resources/catalog/parts.js +34 -20
  193. package/resources/catalog/parts.js.map +1 -1
  194. package/resources/catalog/parts.mjs +34 -20
  195. package/resources/catalog/parts.mjs.map +1 -1
  196. package/resources/catalog/product-lines.d.mts +145 -70
  197. package/resources/catalog/product-lines.d.mts.map +1 -1
  198. package/resources/catalog/product-lines.d.ts +145 -70
  199. package/resources/catalog/product-lines.d.ts.map +1 -1
  200. package/resources/catalog/product-lines.js +31 -26
  201. package/resources/catalog/product-lines.js.map +1 -1
  202. package/resources/catalog/product-lines.mjs +31 -26
  203. package/resources/catalog/product-lines.mjs.map +1 -1
  204. package/resources/catalog/products.d.mts +187 -90
  205. package/resources/catalog/products.d.mts.map +1 -1
  206. package/resources/catalog/products.d.ts +187 -90
  207. package/resources/catalog/products.d.ts.map +1 -1
  208. package/resources/catalog/products.js +25 -20
  209. package/resources/catalog/products.js.map +1 -1
  210. package/resources/catalog/products.mjs +25 -20
  211. package/resources/catalog/products.mjs.map +1 -1
  212. package/resources/catalog/properties/attributes.d.mts +96 -44
  213. package/resources/catalog/properties/attributes.d.mts.map +1 -1
  214. package/resources/catalog/properties/attributes.d.ts +96 -44
  215. package/resources/catalog/properties/attributes.d.ts.map +1 -1
  216. package/resources/catalog/properties/attributes.js +31 -21
  217. package/resources/catalog/properties/attributes.js.map +1 -1
  218. package/resources/catalog/properties/attributes.mjs +31 -21
  219. package/resources/catalog/properties/attributes.mjs.map +1 -1
  220. package/resources/catalog/properties/index.d.mts +2 -2
  221. package/resources/catalog/properties/index.d.mts.map +1 -1
  222. package/resources/catalog/properties/index.d.ts +2 -2
  223. package/resources/catalog/properties/index.d.ts.map +1 -1
  224. package/resources/catalog/properties/index.mjs.map +1 -1
  225. package/resources/catalog/properties/properties.d.mts +70 -47
  226. package/resources/catalog/properties/properties.d.mts.map +1 -1
  227. package/resources/catalog/properties/properties.d.ts +70 -47
  228. package/resources/catalog/properties/properties.d.ts.map +1 -1
  229. package/resources/catalog/properties/properties.js +19 -18
  230. package/resources/catalog/properties/properties.js.map +1 -1
  231. package/resources/catalog/properties/properties.mjs +19 -18
  232. package/resources/catalog/properties/properties.mjs.map +1 -1
  233. package/resources/catalog/properties.d.mts.map +1 -1
  234. package/resources/catalog/properties.d.ts.map +1 -1
  235. package/resources/catalog/properties.mjs.map +1 -1
  236. package/resources/catalog/unit-groups/index.d.mts +2 -2
  237. package/resources/catalog/unit-groups/index.d.mts.map +1 -1
  238. package/resources/catalog/unit-groups/index.d.ts +2 -2
  239. package/resources/catalog/unit-groups/index.d.ts.map +1 -1
  240. package/resources/catalog/unit-groups/index.mjs.map +1 -1
  241. package/resources/catalog/unit-groups/unit-groups.d.mts +130 -83
  242. package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
  243. package/resources/catalog/unit-groups/unit-groups.d.ts +130 -83
  244. package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
  245. package/resources/catalog/unit-groups/unit-groups.js +33 -24
  246. package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
  247. package/resources/catalog/unit-groups/unit-groups.mjs +33 -24
  248. package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
  249. package/resources/catalog/unit-groups/units.d.mts +78 -54
  250. package/resources/catalog/unit-groups/units.d.mts.map +1 -1
  251. package/resources/catalog/unit-groups/units.d.ts +78 -54
  252. package/resources/catalog/unit-groups/units.d.ts.map +1 -1
  253. package/resources/catalog/unit-groups/units.js +34 -25
  254. package/resources/catalog/unit-groups/units.js.map +1 -1
  255. package/resources/catalog/unit-groups/units.mjs +34 -25
  256. package/resources/catalog/unit-groups/units.mjs.map +1 -1
  257. package/resources/catalog/unit-groups.d.mts.map +1 -1
  258. package/resources/catalog/unit-groups.d.ts.map +1 -1
  259. package/resources/catalog/unit-groups.mjs.map +1 -1
  260. package/resources/catalog/units.d.mts +100 -63
  261. package/resources/catalog/units.d.mts.map +1 -1
  262. package/resources/catalog/units.d.ts +100 -63
  263. package/resources/catalog/units.d.ts.map +1 -1
  264. package/resources/catalog/units.js +26 -25
  265. package/resources/catalog/units.js.map +1 -1
  266. package/resources/catalog/units.mjs +26 -25
  267. package/resources/catalog/units.mjs.map +1 -1
  268. package/resources/catalog.d.mts.map +1 -1
  269. package/resources/catalog.d.ts.map +1 -1
  270. package/resources/catalog.mjs.map +1 -1
  271. package/resources/core/addresses/actions.d.mts +12 -5
  272. package/resources/core/addresses/actions.d.mts.map +1 -1
  273. package/resources/core/addresses/actions.d.ts +12 -5
  274. package/resources/core/addresses/actions.d.ts.map +1 -1
  275. package/resources/core/addresses/actions.mjs.map +1 -1
  276. package/resources/core/addresses/addresses.d.mts +5 -2
  277. package/resources/core/addresses/addresses.d.mts.map +1 -1
  278. package/resources/core/addresses/addresses.d.ts +5 -2
  279. package/resources/core/addresses/addresses.d.ts.map +1 -1
  280. package/resources/core/addresses/addresses.js.map +1 -1
  281. package/resources/core/addresses/addresses.mjs.map +1 -1
  282. package/resources/core/addresses/index.d.mts.map +1 -1
  283. package/resources/core/addresses/index.d.ts.map +1 -1
  284. package/resources/core/addresses/index.mjs.map +1 -1
  285. package/resources/core/addresses.d.mts.map +1 -1
  286. package/resources/core/addresses.d.ts.map +1 -1
  287. package/resources/core/addresses.mjs.map +1 -1
  288. package/resources/core/audit-events.d.mts +78 -34
  289. package/resources/core/audit-events.d.mts.map +1 -1
  290. package/resources/core/audit-events.d.ts +78 -34
  291. package/resources/core/audit-events.d.ts.map +1 -1
  292. package/resources/core/audit-events.js +13 -10
  293. package/resources/core/audit-events.js.map +1 -1
  294. package/resources/core/audit-events.mjs +13 -10
  295. package/resources/core/audit-events.mjs.map +1 -1
  296. package/resources/core/core.d.mts +4 -4
  297. package/resources/core/core.d.mts.map +1 -1
  298. package/resources/core/core.d.ts +4 -4
  299. package/resources/core/core.d.ts.map +1 -1
  300. package/resources/core/core.mjs.map +1 -1
  301. package/resources/core/email-logs.d.mts +31 -21
  302. package/resources/core/email-logs.d.mts.map +1 -1
  303. package/resources/core/email-logs.d.ts +31 -21
  304. package/resources/core/email-logs.d.ts.map +1 -1
  305. package/resources/core/email-logs.js +10 -10
  306. package/resources/core/email-logs.js.map +1 -1
  307. package/resources/core/email-logs.mjs +10 -10
  308. package/resources/core/email-logs.mjs.map +1 -1
  309. package/resources/core/index.d.mts +4 -4
  310. package/resources/core/index.d.mts.map +1 -1
  311. package/resources/core/index.d.ts +4 -4
  312. package/resources/core/index.d.ts.map +1 -1
  313. package/resources/core/index.mjs.map +1 -1
  314. package/resources/core/request-logs.d.mts +87 -48
  315. package/resources/core/request-logs.d.mts.map +1 -1
  316. package/resources/core/request-logs.d.ts +87 -48
  317. package/resources/core/request-logs.d.ts.map +1 -1
  318. package/resources/core/request-logs.js +10 -10
  319. package/resources/core/request-logs.js.map +1 -1
  320. package/resources/core/request-logs.mjs +10 -10
  321. package/resources/core/request-logs.mjs.map +1 -1
  322. package/resources/core/sandboxes.d.mts +52 -31
  323. package/resources/core/sandboxes.d.mts.map +1 -1
  324. package/resources/core/sandboxes.d.ts +52 -31
  325. package/resources/core/sandboxes.d.ts.map +1 -1
  326. package/resources/core/sandboxes.js +20 -13
  327. package/resources/core/sandboxes.js.map +1 -1
  328. package/resources/core/sandboxes.mjs +20 -13
  329. package/resources/core/sandboxes.mjs.map +1 -1
  330. package/resources/core.d.mts.map +1 -1
  331. package/resources/core.d.ts.map +1 -1
  332. package/resources/core.mjs.map +1 -1
  333. package/resources/finance/finance.d.mts +69 -35
  334. package/resources/finance/finance.d.mts.map +1 -1
  335. package/resources/finance/finance.d.ts +69 -35
  336. package/resources/finance/finance.d.ts.map +1 -1
  337. package/resources/finance/finance.js +10 -10
  338. package/resources/finance/finance.js.map +1 -1
  339. package/resources/finance/finance.mjs +10 -10
  340. package/resources/finance/finance.mjs.map +1 -1
  341. package/resources/finance/index.d.mts +2 -2
  342. package/resources/finance/index.d.mts.map +1 -1
  343. package/resources/finance/index.d.ts +2 -2
  344. package/resources/finance/index.d.ts.map +1 -1
  345. package/resources/finance/index.mjs.map +1 -1
  346. package/resources/finance/payment-terms.d.mts +72 -43
  347. package/resources/finance/payment-terms.d.mts.map +1 -1
  348. package/resources/finance/payment-terms.d.ts +72 -43
  349. package/resources/finance/payment-terms.d.ts.map +1 -1
  350. package/resources/finance/payment-terms.js +33 -22
  351. package/resources/finance/payment-terms.js.map +1 -1
  352. package/resources/finance/payment-terms.mjs +33 -22
  353. package/resources/finance/payment-terms.mjs.map +1 -1
  354. package/resources/finance.d.mts.map +1 -1
  355. package/resources/finance.d.ts.map +1 -1
  356. package/resources/finance.mjs.map +1 -1
  357. package/resources/identity/account-users/account-users.d.mts +166 -79
  358. package/resources/identity/account-users/account-users.d.mts.map +1 -1
  359. package/resources/identity/account-users/account-users.d.ts +166 -79
  360. package/resources/identity/account-users/account-users.d.ts.map +1 -1
  361. package/resources/identity/account-users/account-users.js +43 -25
  362. package/resources/identity/account-users/account-users.js.map +1 -1
  363. package/resources/identity/account-users/account-users.mjs +43 -25
  364. package/resources/identity/account-users/account-users.mjs.map +1 -1
  365. package/resources/identity/account-users/actions.d.mts +13 -3
  366. package/resources/identity/account-users/actions.d.mts.map +1 -1
  367. package/resources/identity/account-users/actions.d.ts +13 -3
  368. package/resources/identity/account-users/actions.d.ts.map +1 -1
  369. package/resources/identity/account-users/actions.js +13 -3
  370. package/resources/identity/account-users/actions.js.map +1 -1
  371. package/resources/identity/account-users/actions.mjs +13 -3
  372. package/resources/identity/account-users/actions.mjs.map +1 -1
  373. package/resources/identity/account-users/index.d.mts +1 -1
  374. package/resources/identity/account-users/index.d.mts.map +1 -1
  375. package/resources/identity/account-users/index.d.ts +1 -1
  376. package/resources/identity/account-users/index.d.ts.map +1 -1
  377. package/resources/identity/account-users/index.mjs.map +1 -1
  378. package/resources/identity/account-users.d.mts.map +1 -1
  379. package/resources/identity/account-users.d.ts.map +1 -1
  380. package/resources/identity/account-users.mjs.map +1 -1
  381. package/resources/identity/identity.d.mts +2 -2
  382. package/resources/identity/identity.d.mts.map +1 -1
  383. package/resources/identity/identity.d.ts +2 -2
  384. package/resources/identity/identity.d.ts.map +1 -1
  385. package/resources/identity/identity.mjs.map +1 -1
  386. package/resources/identity/index.d.mts +2 -2
  387. package/resources/identity/index.d.mts.map +1 -1
  388. package/resources/identity/index.d.ts +2 -2
  389. package/resources/identity/index.d.ts.map +1 -1
  390. package/resources/identity/index.mjs.map +1 -1
  391. package/resources/identity/roles.d.mts +88 -61
  392. package/resources/identity/roles.d.mts.map +1 -1
  393. package/resources/identity/roles.d.ts +88 -61
  394. package/resources/identity/roles.d.ts.map +1 -1
  395. package/resources/identity/roles.js +33 -27
  396. package/resources/identity/roles.js.map +1 -1
  397. package/resources/identity/roles.mjs +33 -27
  398. package/resources/identity/roles.mjs.map +1 -1
  399. package/resources/identity.d.mts.map +1 -1
  400. package/resources/identity.d.ts.map +1 -1
  401. package/resources/identity.mjs.map +1 -1
  402. package/resources/index.d.mts +2 -1
  403. package/resources/index.d.mts.map +1 -1
  404. package/resources/index.d.ts +2 -1
  405. package/resources/index.d.ts.map +1 -1
  406. package/resources/index.js +3 -1
  407. package/resources/index.js.map +1 -1
  408. package/resources/index.mjs +1 -0
  409. package/resources/index.mjs.map +1 -1
  410. package/resources/operations/carriers/carriers.d.mts +88 -59
  411. package/resources/operations/carriers/carriers.d.mts.map +1 -1
  412. package/resources/operations/carriers/carriers.d.ts +88 -59
  413. package/resources/operations/carriers/carriers.d.ts.map +1 -1
  414. package/resources/operations/carriers/carriers.js +29 -21
  415. package/resources/operations/carriers/carriers.js.map +1 -1
  416. package/resources/operations/carriers/carriers.mjs +29 -21
  417. package/resources/operations/carriers/carriers.mjs.map +1 -1
  418. package/resources/operations/carriers/index.d.mts +2 -2
  419. package/resources/operations/carriers/index.d.mts.map +1 -1
  420. package/resources/operations/carriers/index.d.ts +2 -2
  421. package/resources/operations/carriers/index.d.ts.map +1 -1
  422. package/resources/operations/carriers/index.mjs.map +1 -1
  423. package/resources/operations/carriers/service-levels.d.mts +115 -68
  424. package/resources/operations/carriers/service-levels.d.mts.map +1 -1
  425. package/resources/operations/carriers/service-levels.d.ts +115 -68
  426. package/resources/operations/carriers/service-levels.d.ts.map +1 -1
  427. package/resources/operations/carriers/service-levels.js +37 -30
  428. package/resources/operations/carriers/service-levels.js.map +1 -1
  429. package/resources/operations/carriers/service-levels.mjs +37 -30
  430. package/resources/operations/carriers/service-levels.mjs.map +1 -1
  431. package/resources/operations/carriers.d.mts.map +1 -1
  432. package/resources/operations/carriers.d.ts.map +1 -1
  433. package/resources/operations/carriers.mjs.map +1 -1
  434. package/resources/operations/index.d.mts +4 -4
  435. package/resources/operations/index.d.mts.map +1 -1
  436. package/resources/operations/index.d.ts +4 -4
  437. package/resources/operations/index.d.ts.map +1 -1
  438. package/resources/operations/index.mjs.map +1 -1
  439. package/resources/operations/location-types.d.mts +33 -18
  440. package/resources/operations/location-types.d.mts.map +1 -1
  441. package/resources/operations/location-types.d.ts +33 -18
  442. package/resources/operations/location-types.d.ts.map +1 -1
  443. package/resources/operations/location-types.js +12 -12
  444. package/resources/operations/location-types.js.map +1 -1
  445. package/resources/operations/location-types.mjs +12 -12
  446. package/resources/operations/location-types.mjs.map +1 -1
  447. package/resources/operations/locations.d.mts +131 -65
  448. package/resources/operations/locations.d.mts.map +1 -1
  449. package/resources/operations/locations.d.ts +131 -65
  450. package/resources/operations/locations.d.ts.map +1 -1
  451. package/resources/operations/locations.js +24 -20
  452. package/resources/operations/locations.js.map +1 -1
  453. package/resources/operations/locations.mjs +24 -20
  454. package/resources/operations/locations.mjs.map +1 -1
  455. package/resources/operations/operations.d.mts +4 -4
  456. package/resources/operations/operations.d.mts.map +1 -1
  457. package/resources/operations/operations.d.ts +4 -4
  458. package/resources/operations/operations.d.ts.map +1 -1
  459. package/resources/operations/operations.mjs.map +1 -1
  460. package/resources/operations/scanning-stations.d.mts +143 -69
  461. package/resources/operations/scanning-stations.d.mts.map +1 -1
  462. package/resources/operations/scanning-stations.d.ts +143 -69
  463. package/resources/operations/scanning-stations.d.ts.map +1 -1
  464. package/resources/operations/scanning-stations.js +32 -23
  465. package/resources/operations/scanning-stations.js.map +1 -1
  466. package/resources/operations/scanning-stations.mjs +32 -23
  467. package/resources/operations/scanning-stations.mjs.map +1 -1
  468. package/resources/operations/shipping-terms.d.mts +117 -81
  469. package/resources/operations/shipping-terms.d.mts.map +1 -1
  470. package/resources/operations/shipping-terms.d.ts +117 -81
  471. package/resources/operations/shipping-terms.d.ts.map +1 -1
  472. package/resources/operations/shipping-terms.js +28 -26
  473. package/resources/operations/shipping-terms.js.map +1 -1
  474. package/resources/operations/shipping-terms.mjs +28 -26
  475. package/resources/operations/shipping-terms.mjs.map +1 -1
  476. package/resources/operations.d.mts.map +1 -1
  477. package/resources/operations.d.ts.map +1 -1
  478. package/resources/operations.mjs.map +1 -1
  479. package/resources/sales/account-groups.d.mts +111 -80
  480. package/resources/sales/account-groups.d.mts.map +1 -1
  481. package/resources/sales/account-groups.d.ts +111 -80
  482. package/resources/sales/account-groups.d.ts.map +1 -1
  483. package/resources/sales/account-groups.js +30 -21
  484. package/resources/sales/account-groups.js.map +1 -1
  485. package/resources/sales/account-groups.mjs +30 -21
  486. package/resources/sales/account-groups.mjs.map +1 -1
  487. package/resources/sales/account-statuses.d.mts +41 -23
  488. package/resources/sales/account-statuses.d.mts.map +1 -1
  489. package/resources/sales/account-statuses.d.ts +41 -23
  490. package/resources/sales/account-statuses.d.ts.map +1 -1
  491. package/resources/sales/account-statuses.js +16 -13
  492. package/resources/sales/account-statuses.js.map +1 -1
  493. package/resources/sales/account-statuses.mjs +16 -13
  494. package/resources/sales/account-statuses.mjs.map +1 -1
  495. package/resources/sales/addresses.d.mts +83 -36
  496. package/resources/sales/addresses.d.mts.map +1 -1
  497. package/resources/sales/addresses.d.ts +83 -36
  498. package/resources/sales/addresses.d.ts.map +1 -1
  499. package/resources/sales/addresses.js +29 -19
  500. package/resources/sales/addresses.js.map +1 -1
  501. package/resources/sales/addresses.mjs +29 -19
  502. package/resources/sales/addresses.mjs.map +1 -1
  503. package/resources/sales/customers/actions.d.mts +15 -5
  504. package/resources/sales/customers/actions.d.mts.map +1 -1
  505. package/resources/sales/customers/actions.d.ts +15 -5
  506. package/resources/sales/customers/actions.d.ts.map +1 -1
  507. package/resources/sales/customers/actions.js +6 -2
  508. package/resources/sales/customers/actions.js.map +1 -1
  509. package/resources/sales/customers/actions.mjs +6 -2
  510. package/resources/sales/customers/actions.mjs.map +1 -1
  511. package/resources/sales/customers/customers.d.mts +588 -291
  512. package/resources/sales/customers/customers.d.mts.map +1 -1
  513. package/resources/sales/customers/customers.d.ts +588 -291
  514. package/resources/sales/customers/customers.d.ts.map +1 -1
  515. package/resources/sales/customers/customers.js +58 -30
  516. package/resources/sales/customers/customers.js.map +1 -1
  517. package/resources/sales/customers/customers.mjs +58 -30
  518. package/resources/sales/customers/customers.mjs.map +1 -1
  519. package/resources/sales/customers/index.d.mts +1 -1
  520. package/resources/sales/customers/index.d.mts.map +1 -1
  521. package/resources/sales/customers/index.d.ts +1 -1
  522. package/resources/sales/customers/index.d.ts.map +1 -1
  523. package/resources/sales/customers/index.js.map +1 -1
  524. package/resources/sales/customers/index.mjs.map +1 -1
  525. package/resources/sales/customers.d.mts.map +1 -1
  526. package/resources/sales/customers.d.ts.map +1 -1
  527. package/resources/sales/customers.mjs.map +1 -1
  528. package/resources/sales/index.d.mts +6 -6
  529. package/resources/sales/index.d.mts.map +1 -1
  530. package/resources/sales/index.d.ts +6 -6
  531. package/resources/sales/index.d.ts.map +1 -1
  532. package/resources/sales/index.js.map +1 -1
  533. package/resources/sales/index.mjs.map +1 -1
  534. package/resources/sales/priorities.d.mts +31 -21
  535. package/resources/sales/priorities.d.mts.map +1 -1
  536. package/resources/sales/priorities.d.ts +31 -21
  537. package/resources/sales/priorities.d.ts.map +1 -1
  538. package/resources/sales/priorities.js +10 -10
  539. package/resources/sales/priorities.js.map +1 -1
  540. package/resources/sales/priorities.mjs +10 -10
  541. package/resources/sales/priorities.mjs.map +1 -1
  542. package/resources/sales/sales-orders.d.mts +877 -7
  543. package/resources/sales/sales-orders.d.mts.map +1 -1
  544. package/resources/sales/sales-orders.d.ts +877 -7
  545. package/resources/sales/sales-orders.d.ts.map +1 -1
  546. package/resources/sales/sales-orders.js +45 -3
  547. package/resources/sales/sales-orders.js.map +1 -1
  548. package/resources/sales/sales-orders.mjs +45 -3
  549. package/resources/sales/sales-orders.mjs.map +1 -1
  550. package/resources/sales/sales.d.mts +8 -8
  551. package/resources/sales/sales.d.mts.map +1 -1
  552. package/resources/sales/sales.d.ts +8 -8
  553. package/resources/sales/sales.d.ts.map +1 -1
  554. package/resources/sales/sales.js.map +1 -1
  555. package/resources/sales/sales.mjs.map +1 -1
  556. package/resources/sales.d.mts.map +1 -1
  557. package/resources/sales.d.ts.map +1 -1
  558. package/resources/sales.mjs.map +1 -1
  559. package/resources/settings/index.d.mts +3 -0
  560. package/resources/settings/index.d.mts.map +1 -0
  561. package/resources/settings/index.d.ts +3 -0
  562. package/resources/settings/index.d.ts.map +1 -0
  563. package/resources/settings/index.js +9 -0
  564. package/resources/settings/index.js.map +1 -0
  565. package/resources/settings/index.mjs +4 -0
  566. package/resources/settings/index.mjs.map +1 -0
  567. package/resources/settings/integrations.d.mts +238 -0
  568. package/resources/settings/integrations.d.mts.map +1 -0
  569. package/resources/settings/integrations.d.ts +238 -0
  570. package/resources/settings/integrations.d.ts.map +1 -0
  571. package/resources/settings/integrations.js +80 -0
  572. package/resources/settings/integrations.js.map +1 -0
  573. package/resources/settings/integrations.mjs +76 -0
  574. package/resources/settings/integrations.mjs.map +1 -0
  575. package/resources/settings/settings.d.mts +10 -0
  576. package/resources/settings/settings.d.mts.map +1 -0
  577. package/resources/settings/settings.d.ts +10 -0
  578. package/resources/settings/settings.d.ts.map +1 -0
  579. package/resources/settings/settings.js +17 -0
  580. package/resources/settings/settings.js.map +1 -0
  581. package/resources/settings/settings.mjs +12 -0
  582. package/resources/settings/settings.mjs.map +1 -0
  583. package/resources/settings.d.mts +2 -0
  584. package/resources/settings.d.mts.map +1 -0
  585. package/resources/settings.d.ts +2 -0
  586. package/resources/settings.d.ts.map +1 -0
  587. package/resources/settings.js +6 -0
  588. package/resources/settings.js.map +1 -0
  589. package/resources/settings.mjs +3 -0
  590. package/resources/settings.mjs.map +1 -0
  591. package/resources.d.mts.map +1 -1
  592. package/resources.d.ts.map +1 -1
  593. package/resources.mjs.map +1 -1
  594. package/src/client.ts +13 -3
  595. package/src/resources/auth/api-keys/actions.ts +28 -5
  596. package/src/resources/auth/api-keys/api-keys.ts +142 -78
  597. package/src/resources/auth/api-keys/index.ts +1 -1
  598. package/src/resources/auth/auth.ts +1 -1
  599. package/src/resources/auth/index.ts +1 -1
  600. package/src/resources/catalog/catalog.ts +18 -18
  601. package/src/resources/catalog/index.ts +18 -18
  602. package/src/resources/catalog/item-categories/index.ts +2 -2
  603. package/src/resources/catalog/item-categories/item-categories.ts +116 -86
  604. package/src/resources/catalog/item-categories/properties.ts +9 -4
  605. package/src/resources/catalog/items/attributes.ts +3 -2
  606. package/src/resources/catalog/items/index.ts +2 -2
  607. package/src/resources/catalog/items/items.ts +111 -75
  608. package/src/resources/catalog/materials.ts +159 -112
  609. package/src/resources/catalog/parts.ts +145 -92
  610. package/src/resources/catalog/product-lines.ts +160 -85
  611. package/src/resources/catalog/products.ts +205 -108
  612. package/src/resources/catalog/properties/attributes.ts +110 -58
  613. package/src/resources/catalog/properties/index.ts +4 -4
  614. package/src/resources/catalog/properties/properties.ts +84 -61
  615. package/src/resources/catalog/unit-groups/index.ts +4 -4
  616. package/src/resources/catalog/unit-groups/unit-groups.ts +144 -97
  617. package/src/resources/catalog/unit-groups/units.ts +97 -73
  618. package/src/resources/catalog/units.ts +114 -77
  619. package/src/resources/core/addresses/actions.ts +12 -5
  620. package/src/resources/core/addresses/addresses.ts +5 -2
  621. package/src/resources/core/audit-events.ts +142 -47
  622. package/src/resources/core/core.ts +5 -5
  623. package/src/resources/core/email-logs.ts +39 -29
  624. package/src/resources/core/index.ts +5 -5
  625. package/src/resources/core/request-logs.ts +104 -64
  626. package/src/resources/core/sandboxes.ts +57 -36
  627. package/src/resources/finance/finance.ts +78 -44
  628. package/src/resources/finance/index.ts +4 -4
  629. package/src/resources/finance/payment-terms.ts +85 -56
  630. package/src/resources/identity/account-users/account-users.ts +180 -93
  631. package/src/resources/identity/account-users/actions.ts +13 -3
  632. package/src/resources/identity/account-users/index.ts +2 -2
  633. package/src/resources/identity/identity.ts +4 -4
  634. package/src/resources/identity/index.ts +4 -4
  635. package/src/resources/identity/roles.ts +96 -69
  636. package/src/resources/index.ts +3 -2
  637. package/src/resources/operations/carriers/carriers.ts +97 -68
  638. package/src/resources/operations/carriers/index.ts +4 -4
  639. package/src/resources/operations/carriers/service-levels.ts +136 -89
  640. package/src/resources/operations/index.ts +8 -8
  641. package/src/resources/operations/location-types.ts +38 -23
  642. package/src/resources/operations/locations.ts +140 -74
  643. package/src/resources/operations/operations.ts +8 -8
  644. package/src/resources/operations/scanning-stations.ts +160 -86
  645. package/src/resources/operations/shipping-terms.ts +134 -98
  646. package/src/resources/sales/account-groups.ts +122 -91
  647. package/src/resources/sales/account-statuses.ts +48 -30
  648. package/src/resources/sales/addresses.ts +91 -44
  649. package/src/resources/sales/customers/actions.ts +15 -4
  650. package/src/resources/sales/customers/customers.ts +660 -351
  651. package/src/resources/sales/customers/index.ts +4 -2
  652. package/src/resources/sales/index.ts +25 -6
  653. package/src/resources/sales/priorities.ts +39 -29
  654. package/src/resources/sales/sales-orders.ts +1113 -21
  655. package/src/resources/sales/sales.ts +44 -6
  656. package/src/resources/settings/index.ts +13 -0
  657. package/src/resources/settings/integrations.ts +291 -0
  658. package/src/resources/settings/settings.ts +33 -0
  659. package/src/resources/settings.ts +3 -0
  660. package/src/version.ts +1 -1
  661. package/uploads.d.mts +0 -1
  662. package/uploads.d.mts.map +1 -1
  663. package/uploads.d.ts +0 -1
  664. package/uploads.d.ts.map +1 -1
  665. package/uploads.mjs +0 -1
  666. package/uploads.mjs.map +1 -1
  667. package/version.d.mts +1 -1
  668. package/version.d.ts +1 -1
  669. package/version.js +1 -1
  670. package/version.mjs +1 -1
@@ -11,22 +11,20 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
11
11
  export declare class ItemCategories extends APIResource {
12
12
  properties: PropertiesAPI.Properties;
13
13
  /**
14
- * Creates an account-owned item category.
14
+ * Returns a paginated list of item categories for the current account, including
15
+ * account-specific and global system categories.
15
16
  *
16
17
  * @example
17
18
  * ```ts
18
- * const itemCategory =
19
- * await client.catalog.itemCategories.create({
20
- * name: 'Electronics',
21
- * type: 'material_category',
22
- * unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
23
- * });
19
+ * const listItemCategory =
20
+ * await client.catalog.itemCategories.list();
24
21
  * ```
25
22
  */
26
- create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
23
+ list(query?: ItemCategoryListParams | null | undefined, options?: RequestOptions): APIPromise<ListItemCategory>;
27
24
  /**
28
- * Returns an item category by ID. Includes account-specific and global system
29
- * categories.
25
+ * Returns an item category by ID.
26
+ *
27
+ * Both account-owned categories and global system categories can be retrieved.
30
28
  *
31
29
  * @example
32
30
  * ```ts
@@ -38,32 +36,39 @@ export declare class ItemCategories extends APIResource {
38
36
  */
39
37
  retrieve(id: string, query?: ItemCategoryRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
40
38
  /**
41
- * Partially updates an account-owned item category. Default system categories
42
- * cannot be updated.
39
+ * Creates an account-owned item category.
43
40
  *
44
41
  * @example
45
42
  * ```ts
46
43
  * const itemCategory =
47
- * await client.catalog.itemCategories.update(
48
- * 'ic_01ae7bd7bfd21ca0ab81e1357e',
49
- * );
44
+ * await client.catalog.itemCategories.create({
45
+ * name: 'Electronics',
46
+ * type: 'material_category',
47
+ * unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
48
+ * });
50
49
  * ```
51
50
  */
52
- update(id: string, params?: ItemCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
51
+ create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
53
52
  /**
54
- * Returns a paginated list of item categories for the current account, including
55
- * account-specific and global system categories.
53
+ * Partially updates an account-owned item category.
54
+ *
55
+ * Only the fields provided in the request body are changed. Default system
56
+ * categories cannot be updated.
56
57
  *
57
58
  * @example
58
59
  * ```ts
59
- * const listItemCategory =
60
- * await client.catalog.itemCategories.list();
60
+ * const itemCategory =
61
+ * await client.catalog.itemCategories.update(
62
+ * 'ic_01ae7bd7bfd21ca0ab81e1357e',
63
+ * { name: 'Electronic Components' },
64
+ * );
61
65
  * ```
62
66
  */
63
- list(query?: ItemCategoryListParams | null | undefined, options?: RequestOptions): APIPromise<ListItemCategory>;
67
+ update(id: string, params?: ItemCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
64
68
  /**
65
- * Deletes an account-owned item category. Default system categories cannot be
66
- * deleted.
69
+ * Deletes an account-owned item category.
70
+ *
71
+ * Default system categories cannot be deleted.
67
72
  *
68
73
  * @example
69
74
  * ```ts
@@ -75,8 +80,11 @@ export declare class ItemCategories extends APIResource {
75
80
  */
76
81
  delete(id: string, options?: RequestOptions): APIPromise<ItemCategoryDeleteResponse>;
77
82
  /**
78
- * Changes the unit group associated with an item category. All items in the
79
- * category are updated to use the new base unit asynchronously.
83
+ * Changes the unit group associated with an item category.
84
+ *
85
+ * The new unit group must have the same unit type as the current one — for
86
+ * example, a category measured in `mass` units can only switch to another `mass`
87
+ * unit group. Default system categories cannot be modified.
80
88
  *
81
89
  * @example
82
90
  * ```ts
@@ -94,16 +102,24 @@ export declare class ItemCategories extends APIResource {
94
102
  */
95
103
  export interface CreateItemCategoryRequest {
96
104
  /**
97
- * Display name.
105
+ * Display name of the item category.
98
106
  */
99
107
  name: string;
100
108
  /**
101
- * Item category type. Material categories are used to group materials, while
102
- * product categories are used to group products and parts.
109
+ * What kind of items this category groups.
110
+ *
111
+ * - `material_category`: groups raw materials and components (items of type
112
+ * `material`).
113
+ * - `product_category`: groups finished products and parts (items of type
114
+ * `product` or `part`).
103
115
  */
104
116
  type: 'material_category' | 'product_category';
105
117
  /**
106
- * Unit group ID.
118
+ * ID of the unit group that determines the units of measure available to items in
119
+ * this category.
120
+ *
121
+ * After creation, the unit group can only be replaced by another unit group of the
122
+ * same unit type via the Change Item Category Unit Group endpoint.
107
123
  */
108
124
  unit_group_id: string;
109
125
  }
@@ -129,11 +145,11 @@ export interface ListItemCategory {
129
145
  */
130
146
  export interface UpdateItemCategoryRequest {
131
147
  /**
132
- * Display name.
148
+ * Display name of the item category.
133
149
  */
134
150
  name?: string;
135
151
  /**
136
- * Notes.
152
+ * Free-form notes about the item category.
137
153
  */
138
154
  notes?: string;
139
155
  }
@@ -141,25 +157,34 @@ export interface ItemCategoryDeleteResponse {
141
157
  }
142
158
  export interface ItemCategoryChangeUnitGroupResponse {
143
159
  }
144
- export interface ItemCategoryCreateParams {
160
+ export interface ItemCategoryListParams {
145
161
  /**
146
- * Body param: Display name.
162
+ * Opaque cursor token identifying where the page of results starts.
163
+ *
164
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
165
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
166
+ * page.
147
167
  */
148
- name: string;
168
+ cursor?: string;
169
+ /**
170
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
171
+ * `null`.
172
+ */
173
+ include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
149
174
  /**
150
- * Body param: Item category type. Material categories are used to group materials,
151
- * while product categories are used to group products and parts.
175
+ * Maximum number of results to return in a single page.
152
176
  */
153
- type: 'material_category' | 'product_category';
177
+ limit?: number;
154
178
  /**
155
- * Body param: Unit group ID.
179
+ * Free-text search term used to filter results.
180
+ *
181
+ * Which fields are matched against the term varies by endpoint.
156
182
  */
157
- unit_group_id: string;
183
+ q?: string;
158
184
  /**
159
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
160
- * are returned as `null`.
185
+ * Filter by item category type.
161
186
  */
162
- include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
187
+ type?: 'material_category' | 'product_category';
163
188
  }
164
189
  export interface ItemCategoryRetrieveParams {
165
190
  /**
@@ -168,43 +193,48 @@ export interface ItemCategoryRetrieveParams {
168
193
  */
169
194
  include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
170
195
  }
171
- export interface ItemCategoryUpdateParams {
172
- /**
173
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
174
- * are returned as `null`.
175
- */
176
- include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
196
+ export interface ItemCategoryCreateParams {
177
197
  /**
178
- * Body param: Display name.
198
+ * Body param: Display name of the item category.
179
199
  */
180
- name?: string;
200
+ name: string;
181
201
  /**
182
- * Body param: Notes.
202
+ * Body param: What kind of items this category groups.
203
+ *
204
+ * - `material_category`: groups raw materials and components (items of type
205
+ * `material`).
206
+ * - `product_category`: groups finished products and parts (items of type
207
+ * `product` or `part`).
183
208
  */
184
- notes?: string;
185
- }
186
- export interface ItemCategoryListParams {
209
+ type: 'material_category' | 'product_category';
187
210
  /**
188
- * Cursor token used to retrieve the next or previous page of results.
211
+ * Body param: ID of the unit group that determines the units of measure available
212
+ * to items in this category.
213
+ *
214
+ * After creation, the unit group can only be replaced by another unit group of the
215
+ * same unit type via the Change Item Category Unit Group endpoint.
189
216
  */
190
- cursor?: string;
217
+ unit_group_id: string;
191
218
  /**
192
- * Sub-objects to expand in the response. When omitted, sub-objects are returned as
193
- * `null`.
219
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
220
+ * are returned as `null`.
194
221
  */
195
222
  include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
223
+ }
224
+ export interface ItemCategoryUpdateParams {
196
225
  /**
197
- * Maximum number of results per page (default: 100, max: 1000).
226
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
227
+ * are returned as `null`.
198
228
  */
199
- limit?: number;
229
+ include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
200
230
  /**
201
- * Search query used to filter results.
231
+ * Body param: Display name of the item category.
202
232
  */
203
- q?: string;
233
+ name?: string;
204
234
  /**
205
- * Filter by item category type.
235
+ * Body param: Free-form notes about the item category.
206
236
  */
207
- type?: 'material_category' | 'product_category';
237
+ notes?: string;
208
238
  }
209
239
  export interface ItemCategoryChangeUnitGroupParams {
210
240
  /**
@@ -213,7 +243,7 @@ export interface ItemCategoryChangeUnitGroupParams {
213
243
  id: string;
214
244
  }
215
245
  export declare namespace ItemCategories {
216
- export { type CreateItemCategoryRequest as CreateItemCategoryRequest, type ListItemCategory as ListItemCategory, type UpdateItemCategoryRequest as UpdateItemCategoryRequest, type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse, type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse, type ItemCategoryCreateParams as ItemCategoryCreateParams, type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams, type ItemCategoryUpdateParams as ItemCategoryUpdateParams, type ItemCategoryListParams as ItemCategoryListParams, type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams, };
246
+ export { type CreateItemCategoryRequest as CreateItemCategoryRequest, type ListItemCategory as ListItemCategory, type UpdateItemCategoryRequest as UpdateItemCategoryRequest, type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse, type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse, type ItemCategoryListParams as ItemCategoryListParams, type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams, type ItemCategoryCreateParams as ItemCategoryCreateParams, type ItemCategoryUpdateParams as ItemCategoryUpdateParams, type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams, };
217
247
  export { Properties as Properties, type PropertyUpdateResponse as PropertyUpdateResponse, type PropertyDeleteResponse as PropertyDeleteResponse, type PropertyUpdateParams as PropertyUpdateParams, type PropertyDeleteParams as PropertyDeleteParams, };
218
248
  }
219
249
  //# sourceMappingURL=item-categories.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"item-categories.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/item-categories/item-categories.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,yCAAqC;AAC3D,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB,yBAAqB;AACtB,OAAO,KAAK,QAAQ,2BAAuB;AAC3C,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAKrG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAIpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IASpC;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIpF;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAInD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,mCAAmC;CAAG;AAEvD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;CACjD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAID,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"item-categories.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/item-categories/item-categories.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB;OACM,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAIpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAKrG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IASpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIpF;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAInD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,mCAAmC;CAAG;AAEvD,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;CACjD;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAID,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -11,22 +11,20 @@ import { RequestOptions } from "../../../internal/request-options.js";
11
11
  export declare class ItemCategories extends APIResource {
12
12
  properties: PropertiesAPI.Properties;
13
13
  /**
14
- * Creates an account-owned item category.
14
+ * Returns a paginated list of item categories for the current account, including
15
+ * account-specific and global system categories.
15
16
  *
16
17
  * @example
17
18
  * ```ts
18
- * const itemCategory =
19
- * await client.catalog.itemCategories.create({
20
- * name: 'Electronics',
21
- * type: 'material_category',
22
- * unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
23
- * });
19
+ * const listItemCategory =
20
+ * await client.catalog.itemCategories.list();
24
21
  * ```
25
22
  */
26
- create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
23
+ list(query?: ItemCategoryListParams | null | undefined, options?: RequestOptions): APIPromise<ListItemCategory>;
27
24
  /**
28
- * Returns an item category by ID. Includes account-specific and global system
29
- * categories.
25
+ * Returns an item category by ID.
26
+ *
27
+ * Both account-owned categories and global system categories can be retrieved.
30
28
  *
31
29
  * @example
32
30
  * ```ts
@@ -38,32 +36,39 @@ export declare class ItemCategories extends APIResource {
38
36
  */
39
37
  retrieve(id: string, query?: ItemCategoryRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
40
38
  /**
41
- * Partially updates an account-owned item category. Default system categories
42
- * cannot be updated.
39
+ * Creates an account-owned item category.
43
40
  *
44
41
  * @example
45
42
  * ```ts
46
43
  * const itemCategory =
47
- * await client.catalog.itemCategories.update(
48
- * 'ic_01ae7bd7bfd21ca0ab81e1357e',
49
- * );
44
+ * await client.catalog.itemCategories.create({
45
+ * name: 'Electronics',
46
+ * type: 'material_category',
47
+ * unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
48
+ * });
50
49
  * ```
51
50
  */
52
- update(id: string, params?: ItemCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
51
+ create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
53
52
  /**
54
- * Returns a paginated list of item categories for the current account, including
55
- * account-specific and global system categories.
53
+ * Partially updates an account-owned item category.
54
+ *
55
+ * Only the fields provided in the request body are changed. Default system
56
+ * categories cannot be updated.
56
57
  *
57
58
  * @example
58
59
  * ```ts
59
- * const listItemCategory =
60
- * await client.catalog.itemCategories.list();
60
+ * const itemCategory =
61
+ * await client.catalog.itemCategories.update(
62
+ * 'ic_01ae7bd7bfd21ca0ab81e1357e',
63
+ * { name: 'Electronic Components' },
64
+ * );
61
65
  * ```
62
66
  */
63
- list(query?: ItemCategoryListParams | null | undefined, options?: RequestOptions): APIPromise<ListItemCategory>;
67
+ update(id: string, params?: ItemCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory>;
64
68
  /**
65
- * Deletes an account-owned item category. Default system categories cannot be
66
- * deleted.
69
+ * Deletes an account-owned item category.
70
+ *
71
+ * Default system categories cannot be deleted.
67
72
  *
68
73
  * @example
69
74
  * ```ts
@@ -75,8 +80,11 @@ export declare class ItemCategories extends APIResource {
75
80
  */
76
81
  delete(id: string, options?: RequestOptions): APIPromise<ItemCategoryDeleteResponse>;
77
82
  /**
78
- * Changes the unit group associated with an item category. All items in the
79
- * category are updated to use the new base unit asynchronously.
83
+ * Changes the unit group associated with an item category.
84
+ *
85
+ * The new unit group must have the same unit type as the current one — for
86
+ * example, a category measured in `mass` units can only switch to another `mass`
87
+ * unit group. Default system categories cannot be modified.
80
88
  *
81
89
  * @example
82
90
  * ```ts
@@ -94,16 +102,24 @@ export declare class ItemCategories extends APIResource {
94
102
  */
95
103
  export interface CreateItemCategoryRequest {
96
104
  /**
97
- * Display name.
105
+ * Display name of the item category.
98
106
  */
99
107
  name: string;
100
108
  /**
101
- * Item category type. Material categories are used to group materials, while
102
- * product categories are used to group products and parts.
109
+ * What kind of items this category groups.
110
+ *
111
+ * - `material_category`: groups raw materials and components (items of type
112
+ * `material`).
113
+ * - `product_category`: groups finished products and parts (items of type
114
+ * `product` or `part`).
103
115
  */
104
116
  type: 'material_category' | 'product_category';
105
117
  /**
106
- * Unit group ID.
118
+ * ID of the unit group that determines the units of measure available to items in
119
+ * this category.
120
+ *
121
+ * After creation, the unit group can only be replaced by another unit group of the
122
+ * same unit type via the Change Item Category Unit Group endpoint.
107
123
  */
108
124
  unit_group_id: string;
109
125
  }
@@ -129,11 +145,11 @@ export interface ListItemCategory {
129
145
  */
130
146
  export interface UpdateItemCategoryRequest {
131
147
  /**
132
- * Display name.
148
+ * Display name of the item category.
133
149
  */
134
150
  name?: string;
135
151
  /**
136
- * Notes.
152
+ * Free-form notes about the item category.
137
153
  */
138
154
  notes?: string;
139
155
  }
@@ -141,25 +157,34 @@ export interface ItemCategoryDeleteResponse {
141
157
  }
142
158
  export interface ItemCategoryChangeUnitGroupResponse {
143
159
  }
144
- export interface ItemCategoryCreateParams {
160
+ export interface ItemCategoryListParams {
145
161
  /**
146
- * Body param: Display name.
162
+ * Opaque cursor token identifying where the page of results starts.
163
+ *
164
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
165
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
166
+ * page.
147
167
  */
148
- name: string;
168
+ cursor?: string;
169
+ /**
170
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
171
+ * `null`.
172
+ */
173
+ include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
149
174
  /**
150
- * Body param: Item category type. Material categories are used to group materials,
151
- * while product categories are used to group products and parts.
175
+ * Maximum number of results to return in a single page.
152
176
  */
153
- type: 'material_category' | 'product_category';
177
+ limit?: number;
154
178
  /**
155
- * Body param: Unit group ID.
179
+ * Free-text search term used to filter results.
180
+ *
181
+ * Which fields are matched against the term varies by endpoint.
156
182
  */
157
- unit_group_id: string;
183
+ q?: string;
158
184
  /**
159
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
160
- * are returned as `null`.
185
+ * Filter by item category type.
161
186
  */
162
- include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
187
+ type?: 'material_category' | 'product_category';
163
188
  }
164
189
  export interface ItemCategoryRetrieveParams {
165
190
  /**
@@ -168,43 +193,48 @@ export interface ItemCategoryRetrieveParams {
168
193
  */
169
194
  include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
170
195
  }
171
- export interface ItemCategoryUpdateParams {
172
- /**
173
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
174
- * are returned as `null`.
175
- */
176
- include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
196
+ export interface ItemCategoryCreateParams {
177
197
  /**
178
- * Body param: Display name.
198
+ * Body param: Display name of the item category.
179
199
  */
180
- name?: string;
200
+ name: string;
181
201
  /**
182
- * Body param: Notes.
202
+ * Body param: What kind of items this category groups.
203
+ *
204
+ * - `material_category`: groups raw materials and components (items of type
205
+ * `material`).
206
+ * - `product_category`: groups finished products and parts (items of type
207
+ * `product` or `part`).
183
208
  */
184
- notes?: string;
185
- }
186
- export interface ItemCategoryListParams {
209
+ type: 'material_category' | 'product_category';
187
210
  /**
188
- * Cursor token used to retrieve the next or previous page of results.
211
+ * Body param: ID of the unit group that determines the units of measure available
212
+ * to items in this category.
213
+ *
214
+ * After creation, the unit group can only be replaced by another unit group of the
215
+ * same unit type via the Change Item Category Unit Group endpoint.
189
216
  */
190
- cursor?: string;
217
+ unit_group_id: string;
191
218
  /**
192
- * Sub-objects to expand in the response. When omitted, sub-objects are returned as
193
- * `null`.
219
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
220
+ * are returned as `null`.
194
221
  */
195
222
  include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
223
+ }
224
+ export interface ItemCategoryUpdateParams {
196
225
  /**
197
- * Maximum number of results per page (default: 100, max: 1000).
226
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
227
+ * are returned as `null`.
198
228
  */
199
- limit?: number;
229
+ include?: Array<'owner' | 'owner.account' | 'properties' | 'unit_group' | 'unit_group.base_unit' | 'unit_group.associated_units' | 'unit_group.associated_units.unit'>;
200
230
  /**
201
- * Search query used to filter results.
231
+ * Body param: Display name of the item category.
202
232
  */
203
- q?: string;
233
+ name?: string;
204
234
  /**
205
- * Filter by item category type.
235
+ * Body param: Free-form notes about the item category.
206
236
  */
207
- type?: 'material_category' | 'product_category';
237
+ notes?: string;
208
238
  }
209
239
  export interface ItemCategoryChangeUnitGroupParams {
210
240
  /**
@@ -213,7 +243,7 @@ export interface ItemCategoryChangeUnitGroupParams {
213
243
  id: string;
214
244
  }
215
245
  export declare namespace ItemCategories {
216
- export { type CreateItemCategoryRequest as CreateItemCategoryRequest, type ListItemCategory as ListItemCategory, type UpdateItemCategoryRequest as UpdateItemCategoryRequest, type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse, type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse, type ItemCategoryCreateParams as ItemCategoryCreateParams, type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams, type ItemCategoryUpdateParams as ItemCategoryUpdateParams, type ItemCategoryListParams as ItemCategoryListParams, type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams, };
246
+ export { type CreateItemCategoryRequest as CreateItemCategoryRequest, type ListItemCategory as ListItemCategory, type UpdateItemCategoryRequest as UpdateItemCategoryRequest, type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse, type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse, type ItemCategoryListParams as ItemCategoryListParams, type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams, type ItemCategoryCreateParams as ItemCategoryCreateParams, type ItemCategoryUpdateParams as ItemCategoryUpdateParams, type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams, };
217
247
  export { Properties as Properties, type PropertyUpdateResponse as PropertyUpdateResponse, type PropertyDeleteResponse as PropertyDeleteResponse, type PropertyUpdateParams as PropertyUpdateParams, type PropertyDeleteParams as PropertyDeleteParams, };
218
248
  }
219
249
  //# sourceMappingURL=item-categories.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"item-categories.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/item-categories/item-categories.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,UAAU,wCAAqC;AAC3D,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB,wBAAqB;AACtB,OAAO,KAAK,QAAQ,0BAAuB;AAC3C,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAKrG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAIpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IASpC;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIpF;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAInD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,mCAAmC;CAAG;AAEvD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;CACjD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAID,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"item-categories.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/item-categories/item-categories.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB;OACM,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAIpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAKrG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IASpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIpF;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAInD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,mCAAmC;CAAG;AAEvD,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;CACjD;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,OAAO,GACP,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,6BAA6B,GAC7B,kCAAkC,CACrC,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAID,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}