@augno/sdk 0.13.4 → 0.14.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 (425) hide show
  1. package/CHANGELOG.md +3 -3
  2. package/package.json +1 -1
  3. package/resources/catalog/catalog.d.mts +10 -10
  4. package/resources/catalog/catalog.d.mts.map +1 -1
  5. package/resources/catalog/catalog.d.ts +10 -10
  6. package/resources/catalog/catalog.d.ts.map +1 -1
  7. package/resources/catalog/catalog.js +10 -10
  8. package/resources/catalog/catalog.js.map +1 -1
  9. package/resources/catalog/catalog.mjs +10 -10
  10. package/resources/catalog/catalog.mjs.map +1 -1
  11. package/resources/catalog/index.d.mts +5 -5
  12. package/resources/catalog/index.d.ts +5 -5
  13. package/resources/catalog/index.js +14 -14
  14. package/resources/catalog/index.js.map +1 -1
  15. package/resources/catalog/index.mjs +5 -5
  16. package/resources/catalog/item-categories/actions.d.mts +93 -0
  17. package/resources/catalog/item-categories/actions.d.mts.map +1 -0
  18. package/resources/catalog/item-categories/actions.d.ts +93 -0
  19. package/resources/catalog/item-categories/actions.d.ts.map +1 -0
  20. package/resources/catalog/item-categories/actions.js +35 -0
  21. package/resources/catalog/item-categories/actions.js.map +1 -0
  22. package/resources/catalog/item-categories/actions.mjs +31 -0
  23. package/resources/catalog/item-categories/actions.mjs.map +1 -0
  24. package/resources/catalog/item-categories/index.d.mts +1 -0
  25. package/resources/catalog/item-categories/index.d.mts.map +1 -1
  26. package/resources/catalog/item-categories/index.d.ts +1 -0
  27. package/resources/catalog/item-categories/index.d.ts.map +1 -1
  28. package/resources/catalog/item-categories/index.js +3 -1
  29. package/resources/catalog/item-categories/index.js.map +1 -1
  30. package/resources/catalog/item-categories/index.mjs +1 -0
  31. package/resources/catalog/item-categories/index.mjs.map +1 -1
  32. package/resources/catalog/item-categories/item-categories.d.mts +4 -0
  33. package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
  34. package/resources/catalog/item-categories/item-categories.d.ts +4 -0
  35. package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
  36. package/resources/catalog/item-categories/item-categories.js +4 -0
  37. package/resources/catalog/item-categories/item-categories.js.map +1 -1
  38. package/resources/catalog/item-categories/item-categories.mjs +4 -0
  39. package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
  40. package/resources/catalog/items/items.d.mts +1 -1
  41. package/resources/catalog/items/items.d.mts.map +1 -1
  42. package/resources/catalog/items/items.d.ts +1 -1
  43. package/resources/catalog/items/items.d.ts.map +1 -1
  44. package/resources/catalog/items/items.js.map +1 -1
  45. package/resources/catalog/items/items.mjs.map +1 -1
  46. package/resources/catalog/materials/actions.d.mts +118 -0
  47. package/resources/catalog/materials/actions.d.mts.map +1 -0
  48. package/resources/catalog/materials/actions.d.ts +118 -0
  49. package/resources/catalog/materials/actions.d.ts.map +1 -0
  50. package/resources/catalog/materials/actions.js +33 -0
  51. package/resources/catalog/materials/actions.js.map +1 -0
  52. package/resources/catalog/materials/actions.mjs +29 -0
  53. package/resources/catalog/materials/actions.mjs.map +1 -0
  54. package/resources/catalog/materials/index.d.mts +3 -0
  55. package/resources/catalog/materials/index.d.mts.map +1 -0
  56. package/resources/catalog/materials/index.d.ts +3 -0
  57. package/resources/catalog/materials/index.d.ts.map +1 -0
  58. package/resources/catalog/materials/index.js +9 -0
  59. package/resources/catalog/materials/index.js.map +1 -0
  60. package/resources/catalog/materials/index.mjs +4 -0
  61. package/resources/catalog/materials/index.mjs.map +1 -0
  62. package/resources/catalog/materials/materials.d.mts +483 -0
  63. package/resources/catalog/materials/materials.d.mts.map +1 -0
  64. package/resources/catalog/materials/materials.d.ts +483 -0
  65. package/resources/catalog/materials/materials.d.ts.map +1 -0
  66. package/resources/catalog/materials/materials.js +159 -0
  67. package/resources/catalog/materials/materials.js.map +1 -0
  68. package/resources/catalog/materials/materials.mjs +154 -0
  69. package/resources/catalog/materials/materials.mjs.map +1 -0
  70. package/resources/catalog/materials.d.mts +1 -478
  71. package/resources/catalog/materials.d.mts.map +1 -1
  72. package/resources/catalog/materials.d.ts +1 -478
  73. package/resources/catalog/materials.d.ts.map +1 -1
  74. package/resources/catalog/materials.js +2 -147
  75. package/resources/catalog/materials.js.map +1 -1
  76. package/resources/catalog/materials.mjs +1 -145
  77. package/resources/catalog/materials.mjs.map +1 -1
  78. package/resources/catalog/parts/actions.d.mts +108 -0
  79. package/resources/catalog/parts/actions.d.mts.map +1 -0
  80. package/resources/catalog/parts/actions.d.ts +108 -0
  81. package/resources/catalog/parts/actions.d.ts.map +1 -0
  82. package/resources/catalog/parts/actions.js +32 -0
  83. package/resources/catalog/parts/actions.js.map +1 -0
  84. package/resources/catalog/parts/actions.mjs +28 -0
  85. package/resources/catalog/parts/actions.mjs.map +1 -0
  86. package/resources/catalog/parts/index.d.mts +3 -0
  87. package/resources/catalog/parts/index.d.mts.map +1 -0
  88. package/resources/catalog/parts/index.d.ts +3 -0
  89. package/resources/catalog/parts/index.d.ts.map +1 -0
  90. package/resources/catalog/parts/index.js +9 -0
  91. package/resources/catalog/parts/index.js.map +1 -0
  92. package/resources/catalog/parts/index.mjs +4 -0
  93. package/resources/catalog/parts/index.mjs.map +1 -0
  94. package/resources/catalog/parts/parts.d.mts +362 -0
  95. package/resources/catalog/parts/parts.d.mts.map +1 -0
  96. package/resources/catalog/parts/parts.d.ts +362 -0
  97. package/resources/catalog/parts/parts.d.ts.map +1 -0
  98. package/resources/catalog/parts/parts.js +138 -0
  99. package/resources/catalog/parts/parts.js.map +1 -0
  100. package/resources/catalog/parts/parts.mjs +133 -0
  101. package/resources/catalog/parts/parts.mjs.map +1 -0
  102. package/resources/catalog/parts.d.mts +1 -357
  103. package/resources/catalog/parts.d.mts.map +1 -1
  104. package/resources/catalog/parts.d.ts +1 -357
  105. package/resources/catalog/parts.d.ts.map +1 -1
  106. package/resources/catalog/parts.js +2 -126
  107. package/resources/catalog/parts.js.map +1 -1
  108. package/resources/catalog/parts.mjs +1 -124
  109. package/resources/catalog/parts.mjs.map +1 -1
  110. package/resources/catalog/product-lines/actions.d.mts +82 -0
  111. package/resources/catalog/product-lines/actions.d.mts.map +1 -0
  112. package/resources/catalog/product-lines/actions.d.ts +82 -0
  113. package/resources/catalog/product-lines/actions.d.ts.map +1 -0
  114. package/resources/catalog/product-lines/actions.js +34 -0
  115. package/resources/catalog/product-lines/actions.js.map +1 -0
  116. package/resources/catalog/product-lines/actions.mjs +30 -0
  117. package/resources/catalog/product-lines/actions.mjs.map +1 -0
  118. package/resources/catalog/product-lines/index.d.mts +3 -0
  119. package/resources/catalog/product-lines/index.d.mts.map +1 -0
  120. package/resources/catalog/product-lines/index.d.ts +3 -0
  121. package/resources/catalog/product-lines/index.d.ts.map +1 -0
  122. package/resources/catalog/product-lines/index.js +9 -0
  123. package/resources/catalog/product-lines/index.js.map +1 -0
  124. package/resources/catalog/product-lines/index.mjs +4 -0
  125. package/resources/catalog/product-lines/index.mjs.map +1 -0
  126. package/resources/catalog/product-lines/product-lines.d.mts +448 -0
  127. package/resources/catalog/product-lines/product-lines.d.mts.map +1 -0
  128. package/resources/catalog/product-lines/product-lines.d.ts +448 -0
  129. package/resources/catalog/product-lines/product-lines.d.ts.map +1 -0
  130. package/resources/catalog/product-lines/product-lines.js +136 -0
  131. package/resources/catalog/product-lines/product-lines.js.map +1 -0
  132. package/resources/catalog/product-lines/product-lines.mjs +131 -0
  133. package/resources/catalog/product-lines/product-lines.mjs.map +1 -0
  134. package/resources/catalog/product-lines.d.mts +1 -443
  135. package/resources/catalog/product-lines.d.mts.map +1 -1
  136. package/resources/catalog/product-lines.d.ts +1 -443
  137. package/resources/catalog/product-lines.d.ts.map +1 -1
  138. package/resources/catalog/product-lines.js +2 -124
  139. package/resources/catalog/product-lines.js.map +1 -1
  140. package/resources/catalog/product-lines.mjs +1 -122
  141. package/resources/catalog/product-lines.mjs.map +1 -1
  142. package/resources/catalog/products/actions.d.mts +124 -0
  143. package/resources/catalog/products/actions.d.mts.map +1 -0
  144. package/resources/catalog/products/actions.d.ts +124 -0
  145. package/resources/catalog/products/actions.d.ts.map +1 -0
  146. package/resources/catalog/products/actions.js +33 -0
  147. package/resources/catalog/products/actions.js.map +1 -0
  148. package/resources/catalog/products/actions.mjs +29 -0
  149. package/resources/catalog/products/actions.mjs.map +1 -0
  150. package/resources/catalog/products/index.d.mts +3 -0
  151. package/resources/catalog/products/index.d.mts.map +1 -0
  152. package/resources/catalog/products/index.d.ts +3 -0
  153. package/resources/catalog/products/index.d.ts.map +1 -0
  154. package/resources/catalog/products/index.js +9 -0
  155. package/resources/catalog/products/index.js.map +1 -0
  156. package/resources/catalog/products/index.mjs +4 -0
  157. package/resources/catalog/products/index.mjs.map +1 -0
  158. package/resources/catalog/products/products.d.mts +585 -0
  159. package/resources/catalog/products/products.d.mts.map +1 -0
  160. package/resources/catalog/products/products.d.ts +585 -0
  161. package/resources/catalog/products/products.d.ts.map +1 -0
  162. package/resources/catalog/products/products.js +185 -0
  163. package/resources/catalog/products/products.js.map +1 -0
  164. package/resources/catalog/products/products.mjs +180 -0
  165. package/resources/catalog/products/products.mjs.map +1 -0
  166. package/resources/catalog/products.d.mts +1 -580
  167. package/resources/catalog/products.d.mts.map +1 -1
  168. package/resources/catalog/products.d.ts +1 -580
  169. package/resources/catalog/products.d.ts.map +1 -1
  170. package/resources/catalog/products.js +2 -173
  171. package/resources/catalog/products.js.map +1 -1
  172. package/resources/catalog/products.mjs +1 -171
  173. package/resources/catalog/products.mjs.map +1 -1
  174. package/resources/catalog/properties/actions.d.mts +86 -0
  175. package/resources/catalog/properties/actions.d.mts.map +1 -0
  176. package/resources/catalog/properties/actions.d.ts +86 -0
  177. package/resources/catalog/properties/actions.d.ts.map +1 -0
  178. package/resources/catalog/properties/actions.js +33 -0
  179. package/resources/catalog/properties/actions.js.map +1 -0
  180. package/resources/catalog/properties/actions.mjs +29 -0
  181. package/resources/catalog/properties/actions.mjs.map +1 -0
  182. package/resources/catalog/properties/index.d.mts +1 -0
  183. package/resources/catalog/properties/index.d.mts.map +1 -1
  184. package/resources/catalog/properties/index.d.ts +1 -0
  185. package/resources/catalog/properties/index.d.ts.map +1 -1
  186. package/resources/catalog/properties/index.js +3 -1
  187. package/resources/catalog/properties/index.js.map +1 -1
  188. package/resources/catalog/properties/index.mjs +1 -0
  189. package/resources/catalog/properties/index.mjs.map +1 -1
  190. package/resources/catalog/properties/properties.d.mts +4 -0
  191. package/resources/catalog/properties/properties.d.mts.map +1 -1
  192. package/resources/catalog/properties/properties.d.ts +4 -0
  193. package/resources/catalog/properties/properties.d.ts.map +1 -1
  194. package/resources/catalog/properties/properties.js +4 -0
  195. package/resources/catalog/properties/properties.js.map +1 -1
  196. package/resources/catalog/properties/properties.mjs +4 -0
  197. package/resources/catalog/properties/properties.mjs.map +1 -1
  198. package/resources/catalog/unit-groups/actions.d.mts +116 -0
  199. package/resources/catalog/unit-groups/actions.d.mts.map +1 -0
  200. package/resources/catalog/unit-groups/actions.d.ts +116 -0
  201. package/resources/catalog/unit-groups/actions.d.ts.map +1 -0
  202. package/resources/catalog/unit-groups/actions.js +39 -0
  203. package/resources/catalog/unit-groups/actions.js.map +1 -0
  204. package/resources/catalog/unit-groups/actions.mjs +35 -0
  205. package/resources/catalog/unit-groups/actions.mjs.map +1 -0
  206. package/resources/catalog/unit-groups/index.d.mts +1 -0
  207. package/resources/catalog/unit-groups/index.d.mts.map +1 -1
  208. package/resources/catalog/unit-groups/index.d.ts +1 -0
  209. package/resources/catalog/unit-groups/index.d.ts.map +1 -1
  210. package/resources/catalog/unit-groups/index.js +3 -1
  211. package/resources/catalog/unit-groups/index.js.map +1 -1
  212. package/resources/catalog/unit-groups/index.mjs +1 -0
  213. package/resources/catalog/unit-groups/index.mjs.map +1 -1
  214. package/resources/catalog/unit-groups/unit-groups.d.mts +9 -5
  215. package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
  216. package/resources/catalog/unit-groups/unit-groups.d.ts +9 -5
  217. package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
  218. package/resources/catalog/unit-groups/unit-groups.js +6 -2
  219. package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
  220. package/resources/catalog/unit-groups/unit-groups.mjs +6 -2
  221. package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
  222. package/resources/catalog/units/actions.d.mts +91 -0
  223. package/resources/catalog/units/actions.d.mts.map +1 -0
  224. package/resources/catalog/units/actions.d.ts +91 -0
  225. package/resources/catalog/units/actions.d.ts.map +1 -0
  226. package/resources/catalog/units/actions.js +37 -0
  227. package/resources/catalog/units/actions.js.map +1 -0
  228. package/resources/catalog/units/actions.mjs +33 -0
  229. package/resources/catalog/units/actions.mjs.map +1 -0
  230. package/resources/catalog/units/index.d.mts +3 -0
  231. package/resources/catalog/units/index.d.mts.map +1 -0
  232. package/resources/catalog/units/index.d.ts +3 -0
  233. package/resources/catalog/units/index.d.ts.map +1 -0
  234. package/resources/catalog/units/index.js +9 -0
  235. package/resources/catalog/units/index.js.map +1 -0
  236. package/resources/catalog/units/index.mjs +4 -0
  237. package/resources/catalog/units/index.mjs.map +1 -0
  238. package/resources/catalog/units/units.d.mts +449 -0
  239. package/resources/catalog/units/units.d.mts.map +1 -0
  240. package/resources/catalog/units/units.d.ts +449 -0
  241. package/resources/catalog/units/units.d.ts.map +1 -0
  242. package/resources/catalog/units/units.js +122 -0
  243. package/resources/catalog/units/units.js.map +1 -0
  244. package/resources/catalog/units/units.mjs +117 -0
  245. package/resources/catalog/units/units.mjs.map +1 -0
  246. package/resources/catalog/units.d.mts +1 -444
  247. package/resources/catalog/units.d.mts.map +1 -1
  248. package/resources/catalog/units.d.ts +1 -444
  249. package/resources/catalog/units.d.ts.map +1 -1
  250. package/resources/catalog/units.js +2 -110
  251. package/resources/catalog/units.js.map +1 -1
  252. package/resources/catalog/units.mjs +1 -108
  253. package/resources/catalog/units.mjs.map +1 -1
  254. package/resources/core/audit-events.d.mts +6 -6
  255. package/resources/core/audit-events.d.mts.map +1 -1
  256. package/resources/core/audit-events.d.ts +6 -6
  257. package/resources/core/audit-events.d.ts.map +1 -1
  258. package/resources/core/core.d.mts +6 -2
  259. package/resources/core/core.d.mts.map +1 -1
  260. package/resources/core/core.d.ts +6 -2
  261. package/resources/core/core.d.ts.map +1 -1
  262. package/resources/core/core.js +4 -0
  263. package/resources/core/core.js.map +1 -1
  264. package/resources/core/core.mjs +4 -0
  265. package/resources/core/core.mjs.map +1 -1
  266. package/resources/core/index.d.mts +1 -0
  267. package/resources/core/index.d.mts.map +1 -1
  268. package/resources/core/index.d.ts +1 -0
  269. package/resources/core/index.d.ts.map +1 -1
  270. package/resources/core/index.js +3 -1
  271. package/resources/core/index.js.map +1 -1
  272. package/resources/core/index.mjs +1 -0
  273. package/resources/core/index.mjs.map +1 -1
  274. package/resources/core/jobs.d.mts +236 -0
  275. package/resources/core/jobs.d.mts.map +1 -0
  276. package/resources/core/jobs.d.ts +236 -0
  277. package/resources/core/jobs.d.ts.map +1 -0
  278. package/resources/core/jobs.js +43 -0
  279. package/resources/core/jobs.js.map +1 -0
  280. package/resources/core/jobs.mjs +39 -0
  281. package/resources/core/jobs.mjs.map +1 -0
  282. package/resources/messaging/conversations/conversations.d.mts +3 -3
  283. package/resources/messaging/conversations/conversations.d.mts.map +1 -1
  284. package/resources/messaging/conversations/conversations.d.ts +3 -3
  285. package/resources/messaging/conversations/conversations.d.ts.map +1 -1
  286. package/resources/messaging/conversations/conversations.js.map +1 -1
  287. package/resources/messaging/conversations/conversations.mjs.map +1 -1
  288. package/resources/messaging/conversations/links.d.mts +2 -2
  289. package/resources/messaging/conversations/links.d.mts.map +1 -1
  290. package/resources/messaging/conversations/links.d.ts +2 -2
  291. package/resources/messaging/conversations/links.d.ts.map +1 -1
  292. package/resources/messaging/conversations/messages.d.mts +2 -2
  293. package/resources/messaging/conversations/messages.d.mts.map +1 -1
  294. package/resources/messaging/conversations/messages.d.ts +2 -2
  295. package/resources/messaging/conversations/messages.d.ts.map +1 -1
  296. package/resources/messaging/notifications/notifications.d.mts +2 -2
  297. package/resources/messaging/notifications/notifications.d.mts.map +1 -1
  298. package/resources/messaging/notifications/notifications.d.ts +2 -2
  299. package/resources/messaging/notifications/notifications.d.ts.map +1 -1
  300. package/resources/messaging/notifications/notifications.js.map +1 -1
  301. package/resources/messaging/notifications/notifications.mjs.map +1 -1
  302. package/resources/operations/demand-overrides.d.mts +1 -1
  303. package/resources/operations/demand-overrides.d.mts.map +1 -1
  304. package/resources/operations/demand-overrides.d.ts +1 -1
  305. package/resources/operations/demand-overrides.d.ts.map +1 -1
  306. package/resources/operations/index.d.mts +1 -1
  307. package/resources/operations/index.d.ts +1 -1
  308. package/resources/operations/index.js +8 -8
  309. package/resources/operations/index.js.map +1 -1
  310. package/resources/operations/index.mjs +1 -1
  311. package/resources/operations/locations/actions.d.mts +67 -0
  312. package/resources/operations/locations/actions.d.mts.map +1 -0
  313. package/resources/operations/locations/actions.d.ts +67 -0
  314. package/resources/operations/locations/actions.d.ts.map +1 -0
  315. package/resources/operations/locations/actions.js +27 -0
  316. package/resources/operations/locations/actions.js.map +1 -0
  317. package/resources/operations/locations/actions.mjs +23 -0
  318. package/resources/operations/locations/actions.mjs.map +1 -0
  319. package/resources/operations/locations/index.d.mts +3 -0
  320. package/resources/operations/locations/index.d.mts.map +1 -0
  321. package/resources/operations/locations/index.d.ts +3 -0
  322. package/resources/operations/locations/index.d.ts.map +1 -0
  323. package/resources/operations/locations/index.js +9 -0
  324. package/resources/operations/locations/index.js.map +1 -0
  325. package/resources/operations/locations/index.mjs +4 -0
  326. package/resources/operations/locations/index.mjs.map +1 -0
  327. package/resources/operations/locations/locations.d.mts +273 -0
  328. package/resources/operations/locations/locations.d.mts.map +1 -0
  329. package/resources/operations/locations/locations.d.ts +273 -0
  330. package/resources/operations/locations/locations.d.ts.map +1 -0
  331. package/resources/operations/locations/locations.js +113 -0
  332. package/resources/operations/locations/locations.js.map +1 -0
  333. package/resources/operations/locations/locations.mjs +108 -0
  334. package/resources/operations/locations/locations.mjs.map +1 -0
  335. package/resources/operations/locations.d.mts +1 -268
  336. package/resources/operations/locations.d.mts.map +1 -1
  337. package/resources/operations/locations.d.ts +1 -268
  338. package/resources/operations/locations.d.ts.map +1 -1
  339. package/resources/operations/locations.js +2 -101
  340. package/resources/operations/locations.js.map +1 -1
  341. package/resources/operations/locations.mjs +1 -99
  342. package/resources/operations/locations.mjs.map +1 -1
  343. package/resources/operations/operations.d.mts +2 -2
  344. package/resources/operations/operations.d.mts.map +1 -1
  345. package/resources/operations/operations.d.ts +2 -2
  346. package/resources/operations/operations.d.ts.map +1 -1
  347. package/resources/operations/operations.js +2 -2
  348. package/resources/operations/operations.js.map +1 -1
  349. package/resources/operations/operations.mjs +2 -2
  350. package/resources/operations/operations.mjs.map +1 -1
  351. package/resources/operations/scanning-stations.d.mts +12 -4
  352. package/resources/operations/scanning-stations.d.mts.map +1 -1
  353. package/resources/operations/scanning-stations.d.ts +12 -4
  354. package/resources/operations/scanning-stations.d.ts.map +1 -1
  355. package/resources/operations/shipping-terms.d.mts +1 -1
  356. package/resources/operations/shipping-terms.d.mts.map +1 -1
  357. package/resources/operations/shipping-terms.d.ts +1 -1
  358. package/resources/operations/shipping-terms.d.ts.map +1 -1
  359. package/resources/sales/customers/customers.d.mts +1 -1
  360. package/resources/sales/customers/customers.d.mts.map +1 -1
  361. package/resources/sales/customers/customers.d.ts +1 -1
  362. package/resources/sales/customers/customers.d.ts.map +1 -1
  363. package/resources/sales/sales-orders/lines/lines.d.mts +2 -2
  364. package/resources/sales/sales-orders/lines/lines.d.ts +2 -2
  365. package/resources/sales/sales-orders/sales-orders.d.mts +4 -4
  366. package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
  367. package/resources/sales/sales-orders/sales-orders.d.ts +4 -4
  368. package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
  369. package/src/resources/catalog/catalog.ts +51 -51
  370. package/src/resources/catalog/index.ts +5 -5
  371. package/src/resources/catalog/item-categories/actions.ts +112 -0
  372. package/src/resources/catalog/item-categories/index.ts +7 -0
  373. package/src/resources/catalog/item-categories/item-categories.ts +18 -0
  374. package/src/resources/catalog/items/items.ts +1 -1
  375. package/src/resources/catalog/materials/actions.ts +141 -0
  376. package/src/resources/catalog/materials/index.ts +22 -0
  377. package/src/resources/catalog/materials/materials.ts +633 -0
  378. package/src/resources/catalog/materials.ts +1 -611
  379. package/src/resources/catalog/parts/actions.ts +129 -0
  380. package/src/resources/catalog/parts/index.ts +20 -0
  381. package/src/resources/catalog/parts/parts.ts +476 -0
  382. package/src/resources/catalog/parts.ts +1 -454
  383. package/src/resources/catalog/product-lines/actions.ts +97 -0
  384. package/src/resources/catalog/product-lines/index.ts +21 -0
  385. package/src/resources/catalog/product-lines/product-lines.ts +552 -0
  386. package/src/resources/catalog/product-lines.ts +1 -532
  387. package/src/resources/catalog/products/actions.ts +148 -0
  388. package/src/resources/catalog/products/index.ts +22 -0
  389. package/src/resources/catalog/products/products.ts +816 -0
  390. package/src/resources/catalog/products.ts +1 -794
  391. package/src/resources/catalog/properties/actions.ts +102 -0
  392. package/src/resources/catalog/properties/index.ts +7 -0
  393. package/src/resources/catalog/properties/properties.ts +18 -0
  394. package/src/resources/catalog/unit-groups/actions.ts +139 -0
  395. package/src/resources/catalog/unit-groups/index.ts +8 -0
  396. package/src/resources/catalog/unit-groups/unit-groups.ts +25 -5
  397. package/src/resources/catalog/units/actions.ts +110 -0
  398. package/src/resources/catalog/units/index.ts +20 -0
  399. package/src/resources/catalog/units/units.ts +547 -0
  400. package/src/resources/catalog/units.ts +1 -532
  401. package/src/resources/core/audit-events.ts +8 -4
  402. package/src/resources/core/core.ts +17 -1
  403. package/src/resources/core/index.ts +9 -0
  404. package/src/resources/core/jobs.ts +321 -0
  405. package/src/resources/messaging/conversations/conversations.ts +6 -3
  406. package/src/resources/messaging/conversations/links.ts +4 -2
  407. package/src/resources/messaging/conversations/messages.ts +4 -2
  408. package/src/resources/messaging/notifications/notifications.ts +4 -2
  409. package/src/resources/operations/demand-overrides.ts +1 -1
  410. package/src/resources/operations/index.ts +1 -1
  411. package/src/resources/operations/locations/actions.ts +82 -0
  412. package/src/resources/operations/locations/index.ts +18 -0
  413. package/src/resources/operations/locations/locations.ts +344 -0
  414. package/src/resources/operations/locations.ts +1 -329
  415. package/src/resources/operations/operations.ts +11 -11
  416. package/src/resources/operations/scanning-stations.ts +12 -4
  417. package/src/resources/operations/shipping-terms.ts +1 -1
  418. package/src/resources/sales/customers/customers.ts +1 -1
  419. package/src/resources/sales/sales-orders/lines/lines.ts +2 -2
  420. package/src/resources/sales/sales-orders/sales-orders.ts +4 -4
  421. package/src/version.ts +1 -1
  422. package/version.d.mts +1 -1
  423. package/version.d.ts +1 -1
  424. package/version.js +1 -1
  425. package/version.mjs +1 -1
@@ -0,0 +1,816 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as APIKeysAPI from '../../auth/api-keys/api-keys';
5
+ import * as ItemsAPI from '../items/items';
6
+ import * as MaterialsAPI from '../materials/materials';
7
+ import * as ProductLinesAPI from '../product-lines/product-lines';
8
+ import * as ActionsAPI from './actions';
9
+ import {
10
+ ActionBulkUpsertParams,
11
+ Actions,
12
+ BulkUpsertProductsRequest,
13
+ UpsertProductInput,
14
+ UpsertProductProperty,
15
+ } from './actions';
16
+ import { APIPromise } from '../../../core/api-promise';
17
+ import { RequestOptions } from '../../../internal/request-options';
18
+ import { path } from '../../../internal/utils/path';
19
+
20
+ /**
21
+ * List and manage products.
22
+ */
23
+ export class Products extends APIResource {
24
+ actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
25
+
26
+ /**
27
+ * Returns a paginated list of products for the target account, newest first.
28
+ *
29
+ * Only products of type `sale` are listed — service, shipping, credit, return, and
30
+ * tax products are excluded and must be retrieved by ID. A request made by a
31
+ * customer-portal buyer always returns portal-visible products only, and its
32
+ * `customer_ids` filter is replaced with the buyer's own account, so the results
33
+ * reflect what that account is entitled to buy.
34
+ *
35
+ * The `q` search term is matched against the SKU and description of each product's
36
+ * item; when it is supplied, products whose SKU matches are returned ahead of the
37
+ * rest.
38
+ *
39
+ * This endpoint requires the permissions: `items:read`, `customers:read`,
40
+ * `suppliers:read`.
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * const listProduct = await client.catalog.products.list();
45
+ * ```
46
+ */
47
+ list(query: ProductListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListProduct> {
48
+ return this._client.get('/v1/catalog/products', { query, ...options });
49
+ }
50
+
51
+ /**
52
+ * Returns a product by ID.
53
+ *
54
+ * This endpoint requires the permissions: `items:read`, `customers:read`,
55
+ * `suppliers:read`.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * const product = await client.catalog.products.retrieve(
60
+ * 'pd_07oe0r7adh2w',
61
+ * );
62
+ * ```
63
+ */
64
+ retrieve(
65
+ id: string,
66
+ query: ProductRetrieveParams | null | undefined = {},
67
+ options?: RequestOptions,
68
+ ): APIPromise<Product> {
69
+ return this._client.get(path`/v1/catalog/products/${id}`, { query, ...options });
70
+ }
71
+
72
+ /**
73
+ * Creates a product and its backing inventory item.
74
+ *
75
+ * The new item starts with zero on-hand inventory, and its pricing defaults to
76
+ * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
77
+ * provided.
78
+ *
79
+ * Only products of type `sale` appear in the product list and export; products
80
+ * created with any other type are still usable on orders and invoices but must be
81
+ * retrieved by ID.
82
+ *
83
+ * This endpoint requires the permission: `items:create`.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * const product = await client.catalog.products.create({
88
+ * category_id: 'ic_d06g9c6yc9ck',
89
+ * sku: 'ALM-2024-1001',
90
+ * type: 'sale',
91
+ * attribute_ids: ['at_rf1w295jt5ia'],
92
+ * description:
93
+ * 'Wireless barcode scanner with charging cradle',
94
+ * notes:
95
+ * 'Ships with a 2-year warranty; register for extended coverage.',
96
+ * portal_visibility: 'visible',
97
+ * product_line_id: 'pdln_k9bnlgvxhxjh',
98
+ * unit_cost: {
99
+ * value: '112.00',
100
+ * numerator_unit_id: 'un_82bd37dae5po',
101
+ * denominator_unit_id: 'un_82bd37dae5po',
102
+ * },
103
+ * unit_price: {
104
+ * value: '199.00',
105
+ * numerator_unit_id: 'un_82bd37dae5po',
106
+ * denominator_unit_id: 'un_82bd37dae5po',
107
+ * },
108
+ * });
109
+ * ```
110
+ */
111
+ create(params: ProductCreateParams, options?: RequestOptions): APIPromise<Product> {
112
+ const { include, ...body } = params;
113
+ return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
114
+ }
115
+
116
+ /**
117
+ * Partially updates a product.
118
+ *
119
+ * `sku`, `description`, `notes`, and `unit_price` all live on the product's
120
+ * backing item and are written there, so the change is visible on the item as
121
+ * well. The product line is reassigned through its own endpoint, and the product
122
+ * type cannot be changed after creation.
123
+ *
124
+ * This endpoint requires the permission: `items:update`.
125
+ *
126
+ * @example
127
+ * ```ts
128
+ * const product = await client.catalog.products.update(
129
+ * 'pd_07oe0r7adh2w',
130
+ * {
131
+ * description:
132
+ * 'Wireless barcode scanner with charging cradle (v2)',
133
+ * notes:
134
+ * 'Firmware 2.1 improves Bluetooth pairing reliability.',
135
+ * portal_visibility: 'visible',
136
+ * sku: 'SKU-002',
137
+ * unit_price: {
138
+ * value: '219.00',
139
+ * numerator_unit_id: 'un_82bd37dae5po',
140
+ * denominator_unit_id: 'un_82bd37dae5po',
141
+ * },
142
+ * },
143
+ * );
144
+ * ```
145
+ */
146
+ update(
147
+ id: string,
148
+ params: ProductUpdateParams | null | undefined = {},
149
+ options?: RequestOptions,
150
+ ): APIPromise<Product> {
151
+ const { include, ...body } = params ?? {};
152
+ return this._client.patch(path`/v1/catalog/products/${id}`, { query: { include }, body, ...options });
153
+ }
154
+
155
+ /**
156
+ * Soft-deletes a product and returns it as it stood at deletion.
157
+ *
158
+ * Deletion marks the product's backing item as deleted, so the item and its
159
+ * inventory drop out of catalog and inventory listings too. Deleting the same
160
+ * product again returns an error saying it has already been deleted.
161
+ *
162
+ * This endpoint requires the permission: `items:delete`.
163
+ *
164
+ * @example
165
+ * ```ts
166
+ * const product = await client.catalog.products.delete(
167
+ * 'pd_07oe0r7adh2w',
168
+ * );
169
+ * ```
170
+ */
171
+ delete(
172
+ id: string,
173
+ params: ProductDeleteParams | null | undefined = {},
174
+ options?: RequestOptions,
175
+ ): APIPromise<Product> {
176
+ const { include } = params ?? {};
177
+ return this._client.delete(path`/v1/catalog/products/${id}`, { query: { include }, ...options });
178
+ }
179
+
180
+ /**
181
+ * Moves a product to a different product line.
182
+ *
183
+ * The target product line must be one your account owns or a shared system line;
184
+ * anything else fails as not found. Because customer accounts are granted access
185
+ * to whole product lines, moving a product changes which buyers can see and order
186
+ * it in the customer portal, and which default commission and freight policies
187
+ * apply to it.
188
+ *
189
+ * This endpoint requires the permission: `items:update`.
190
+ *
191
+ * @example
192
+ * ```ts
193
+ * const product =
194
+ * await client.catalog.products.changeProductLine(
195
+ * 'pdln_k9bnlgvxhxjh',
196
+ * { id: 'pd_07oe0r7adh2w' },
197
+ * );
198
+ * ```
199
+ */
200
+ changeProductLine(
201
+ productLineID: string,
202
+ params: ProductChangeProductLineParams,
203
+ options?: RequestOptions,
204
+ ): APIPromise<Product> {
205
+ const { id, include } = params;
206
+ return this._client.put(path`/v1/catalog/products/${id}/product-line/${productLineID}`, {
207
+ query: { include },
208
+ ...options,
209
+ });
210
+ }
211
+ }
212
+
213
+ /**
214
+ * Request to create a product.
215
+ */
216
+ export interface CreateProductRequest {
217
+ /**
218
+ * ID of the item category for the product's item.
219
+ *
220
+ * The category's unit group determines the default units used for the product's
221
+ * pricing rates and inventory tracking.
222
+ */
223
+ category_id: string;
224
+
225
+ /**
226
+ * Stock keeping unit code for the product's item.
227
+ *
228
+ * Must be unique within the account; creation fails with a conflict error if
229
+ * another item already uses it.
230
+ */
231
+ sku: string;
232
+
233
+ /**
234
+ * Product type code, which determines how the product behaves on orders and
235
+ * invoices.
236
+ *
237
+ * - `sale`: a standard sellable product.
238
+ * - `service`: a non-physical service line, such as labor or installation.
239
+ * - `shipping`: a shipping charge applied to an order.
240
+ * - `credit`: a credit applied against an order or invoice.
241
+ * - `return`: a returned product (RMA).
242
+ * - `tax`: a tax line.
243
+ */
244
+ type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
245
+
246
+ /**
247
+ * Attribute IDs to link to the product's item at creation time.
248
+ *
249
+ * Every ID must already exist in your account; an unknown ID fails the whole
250
+ * request rather than being skipped.
251
+ */
252
+ attribute_ids?: Array<string>;
253
+
254
+ /**
255
+ * Free-form description of the product.
256
+ */
257
+ description?: string;
258
+
259
+ /**
260
+ * Free-form notes about the product.
261
+ */
262
+ notes?: string;
263
+
264
+ /**
265
+ * Whether the product is shown to buyers in the customer portal.
266
+ *
267
+ * - `visible`: buyers can see and order the product in the portal.
268
+ * - `hidden`: the product is concealed from the portal but remains usable
269
+ * internally.
270
+ *
271
+ * When omitted, the product is created hidden, so it must be set to `visible`
272
+ * before buyers can see it.
273
+ */
274
+ portal_visibility?: 'visible' | 'hidden';
275
+
276
+ /**
277
+ * ID of the product line to assign the product to.
278
+ *
279
+ * The product line must be one your account owns or a shared system line; anything
280
+ * else fails as not found. Buyers are granted access to whole product lines, so a
281
+ * product created without one never appears in the customer portal, whatever its
282
+ * `portal_visibility`.
283
+ */
284
+ product_line_id?: string;
285
+
286
+ /**
287
+ * A value expressed as a ratio of two units, supplied on create and update
288
+ * requests.
289
+ *
290
+ * A unit price, for example, has a currency as its numerator unit and the unit the
291
+ * product is bought or sold by as its denominator.
292
+ */
293
+ unit_cost?: MaterialsAPI.RateInput;
294
+
295
+ /**
296
+ * A value expressed as a ratio of two units, supplied on create and update
297
+ * requests.
298
+ *
299
+ * A unit price, for example, has a currency as its numerator unit and the unit the
300
+ * product is bought or sold by as its denominator.
301
+ */
302
+ unit_price?: MaterialsAPI.RateInput;
303
+ }
304
+
305
+ /**
306
+ * A single page of resources, together with the metadata needed to page through
307
+ * the rest of the result set.
308
+ */
309
+ export interface ListProduct {
310
+ /**
311
+ * Resources in this page.
312
+ */
313
+ data: Array<Product>;
314
+
315
+ /**
316
+ * Resource type identifier.
317
+ */
318
+ object: 'list';
319
+
320
+ /**
321
+ * PageInfo describes where the current page sits within a paginated result set and
322
+ * how to move to the adjacent pages.
323
+ *
324
+ * Page a list by following the URLs below rather than assembling cursors yourself.
325
+ * For a top-level list endpoint the URL repeats the original request's query
326
+ * string with only the cursor swapped, so following it preserves the same filters,
327
+ * search term, and page size.
328
+ */
329
+ page_info: APIKeysAPI.PageInfo;
330
+ }
331
+
332
+ /**
333
+ * A catalog entry as it is sold: an inventory item together with its product type,
334
+ * product line, and customer portal visibility.
335
+ *
336
+ * Every product is backed by exactly one item, which carries the SKU, description,
337
+ * pricing, attributes, and inventory position. Creating a product creates that
338
+ * item; deleting the product deletes it.
339
+ */
340
+ export interface Product {
341
+ /**
342
+ * Product ID.
343
+ */
344
+ id: string;
345
+
346
+ /**
347
+ * Creation timestamp.
348
+ */
349
+ created_at: string;
350
+
351
+ /**
352
+ * An entry in your catalog: something you sell, consume, or build with.
353
+ */
354
+ item: ItemsAPI.Item | null;
355
+
356
+ /**
357
+ * Resource type identifier.
358
+ */
359
+ object: 'product';
360
+
361
+ /**
362
+ * Whether the product is shown to buyers in the customer portal.
363
+ *
364
+ * - `visible`: buyers can see and order the product in the portal.
365
+ * - `hidden`: the product is concealed from the portal but remains usable
366
+ * internally.
367
+ *
368
+ * Visibility alone is not enough to expose a product: a buyer only sees it if
369
+ * their account has also been granted access to the product's product line.
370
+ */
371
+ portal_visibility: 'visible' | 'hidden';
372
+
373
+ /**
374
+ * A named grouping of related products in your catalog.
375
+ *
376
+ * A product line carries the default commission and freight policies for the
377
+ * products assigned to it, along with the unit group that determines how those
378
+ * products are measured. Product lines are also the unit that catalog access is
379
+ * granted over, for both customers and account groups.
380
+ */
381
+ product_line: ProductLinesAPI.ProductLine | null;
382
+
383
+ /**
384
+ * Product type code, which determines how the product behaves on orders and
385
+ * invoices.
386
+ *
387
+ * - `sale`: a standard sellable product.
388
+ * - `service`: a non-physical service line, such as labor or installation.
389
+ * - `shipping`: a shipping charge applied to an order.
390
+ * - `credit`: a credit applied against an order or invoice.
391
+ * - `return`: a returned product (RMA).
392
+ * - `tax`: a tax line.
393
+ */
394
+ type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
395
+
396
+ /**
397
+ * Last updated timestamp.
398
+ */
399
+ updated_at: string;
400
+ }
401
+
402
+ /**
403
+ * Request to partially update a product.
404
+ */
405
+ export interface UpdateProductRequest {
406
+ /**
407
+ * Free-form description of the product.
408
+ *
409
+ * Send `null` to clear.
410
+ */
411
+ description?: string | null;
412
+
413
+ /**
414
+ * Free-form notes about the product.
415
+ *
416
+ * Send `null` to clear.
417
+ */
418
+ notes?: string | null;
419
+
420
+ /**
421
+ * Whether the product is shown to buyers in the customer portal.
422
+ *
423
+ * - `visible`: buyers can see and order the product in the portal.
424
+ * - `hidden`: the product is concealed from the portal but remains usable
425
+ * internally.
426
+ */
427
+ portal_visibility?: 'visible' | 'hidden';
428
+
429
+ /**
430
+ * New stock keeping unit code for the product's item.
431
+ *
432
+ * Must be unique within the account; the update fails with a conflict error if
433
+ * another item already uses it.
434
+ */
435
+ sku?: string;
436
+
437
+ /**
438
+ * A value expressed as a ratio of two units, supplied on create and update
439
+ * requests.
440
+ *
441
+ * A unit price, for example, has a currency as its numerator unit and the unit the
442
+ * product is bought or sold by as its denominator.
443
+ */
444
+ unit_price?: MaterialsAPI.RateInput;
445
+ }
446
+
447
+ export interface ProductListParams {
448
+ /**
449
+ * Filter to products whose item carries at least one of these attributes.
450
+ */
451
+ attribute_ids?: Array<string>;
452
+
453
+ /**
454
+ * Filter by the item category the product's item belongs to.
455
+ */
456
+ category_ids?: Array<string>;
457
+
458
+ /**
459
+ * Opaque cursor token identifying where the page of results starts.
460
+ *
461
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
462
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
463
+ * page.
464
+ */
465
+ cursor?: string;
466
+
467
+ /**
468
+ * Restrict results to products these customer accounts are entitled to buy.
469
+ *
470
+ * A product matches when its product line has been granted to the customer
471
+ * directly, through the customer's account group, or through the account group
472
+ * used for the customer's pricing. Combined with `product_line_ids` this widens
473
+ * the results rather than narrowing them: products matching either filter are
474
+ * returned.
475
+ */
476
+ customer_ids?: Array<string>;
477
+
478
+ /**
479
+ * End of creation date range.
480
+ */
481
+ ends_at?: string;
482
+
483
+ /**
484
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
485
+ * `null`.
486
+ */
487
+ include?: Array<
488
+ | 'product_line'
489
+ | 'product_line.unit_group'
490
+ | 'product_line.unit_group.base_unit'
491
+ | 'product_line.unit_group.associated_units'
492
+ | 'product_line.unit_group.associated_units.unit'
493
+ | 'item'
494
+ | 'item.category'
495
+ | 'item.category.properties'
496
+ | 'item.category.unit_group'
497
+ | 'item.category.unit_group.base_unit'
498
+ | 'item.category.unit_group.associated_units'
499
+ | 'item.category.unit_group.associated_units.unit'
500
+ | 'item.unit_value'
501
+ | 'item.unit_cost'
502
+ | 'item.burn_rate'
503
+ | 'item.attributes'
504
+ >;
505
+
506
+ /**
507
+ * Maximum number of results to return in a single page.
508
+ */
509
+ limit?: number;
510
+
511
+ /**
512
+ * Filter by customer portal visibility.
513
+ */
514
+ portal_visibility?: 'visible' | 'hidden';
515
+
516
+ /**
517
+ * Filter by product line IDs.
518
+ *
519
+ * Combined with `customer_ids`, products matching either filter are returned.
520
+ */
521
+ product_line_ids?: Array<string>;
522
+
523
+ /**
524
+ * Free-text search term used to filter results.
525
+ *
526
+ * Which fields are matched against the term varies by endpoint.
527
+ */
528
+ q?: string;
529
+
530
+ /**
531
+ * Start of creation date range.
532
+ */
533
+ starts_at?: string;
534
+ }
535
+
536
+ export interface ProductRetrieveParams {
537
+ /**
538
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
539
+ * `null`.
540
+ */
541
+ include?: Array<
542
+ | 'product_line'
543
+ | 'product_line.unit_group'
544
+ | 'product_line.unit_group.base_unit'
545
+ | 'product_line.unit_group.associated_units'
546
+ | 'product_line.unit_group.associated_units.unit'
547
+ | 'item'
548
+ | 'item.category'
549
+ | 'item.category.properties'
550
+ | 'item.category.unit_group'
551
+ | 'item.category.unit_group.base_unit'
552
+ | 'item.category.unit_group.associated_units'
553
+ | 'item.category.unit_group.associated_units.unit'
554
+ | 'item.unit_value'
555
+ | 'item.unit_cost'
556
+ | 'item.burn_rate'
557
+ | 'item.attributes'
558
+ >;
559
+ }
560
+
561
+ export interface ProductCreateParams {
562
+ /**
563
+ * Body param: ID of the item category for the product's item.
564
+ *
565
+ * The category's unit group determines the default units used for the product's
566
+ * pricing rates and inventory tracking.
567
+ */
568
+ category_id: string;
569
+
570
+ /**
571
+ * Body param: Stock keeping unit code for the product's item.
572
+ *
573
+ * Must be unique within the account; creation fails with a conflict error if
574
+ * another item already uses it.
575
+ */
576
+ sku: string;
577
+
578
+ /**
579
+ * Body param: Product type code, which determines how the product behaves on
580
+ * orders and invoices.
581
+ *
582
+ * - `sale`: a standard sellable product.
583
+ * - `service`: a non-physical service line, such as labor or installation.
584
+ * - `shipping`: a shipping charge applied to an order.
585
+ * - `credit`: a credit applied against an order or invoice.
586
+ * - `return`: a returned product (RMA).
587
+ * - `tax`: a tax line.
588
+ */
589
+ type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
590
+
591
+ /**
592
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
593
+ * are returned as `null`.
594
+ */
595
+ include?: Array<
596
+ | 'product_line'
597
+ | 'product_line.unit_group'
598
+ | 'product_line.unit_group.base_unit'
599
+ | 'product_line.unit_group.associated_units'
600
+ | 'product_line.unit_group.associated_units.unit'
601
+ | 'item'
602
+ | 'item.category'
603
+ | 'item.category.properties'
604
+ | 'item.category.unit_group'
605
+ | 'item.category.unit_group.base_unit'
606
+ | 'item.category.unit_group.associated_units'
607
+ | 'item.category.unit_group.associated_units.unit'
608
+ | 'item.unit_value'
609
+ | 'item.unit_cost'
610
+ | 'item.burn_rate'
611
+ | 'item.attributes'
612
+ >;
613
+
614
+ /**
615
+ * Body param: Attribute IDs to link to the product's item at creation time.
616
+ *
617
+ * Every ID must already exist in your account; an unknown ID fails the whole
618
+ * request rather than being skipped.
619
+ */
620
+ attribute_ids?: Array<string>;
621
+
622
+ /**
623
+ * Body param: Free-form description of the product.
624
+ */
625
+ description?: string;
626
+
627
+ /**
628
+ * Body param: Free-form notes about the product.
629
+ */
630
+ notes?: string;
631
+
632
+ /**
633
+ * Body param: Whether the product is shown to buyers in the customer portal.
634
+ *
635
+ * - `visible`: buyers can see and order the product in the portal.
636
+ * - `hidden`: the product is concealed from the portal but remains usable
637
+ * internally.
638
+ *
639
+ * When omitted, the product is created hidden, so it must be set to `visible`
640
+ * before buyers can see it.
641
+ */
642
+ portal_visibility?: 'visible' | 'hidden';
643
+
644
+ /**
645
+ * Body param: ID of the product line to assign the product to.
646
+ *
647
+ * The product line must be one your account owns or a shared system line; anything
648
+ * else fails as not found. Buyers are granted access to whole product lines, so a
649
+ * product created without one never appears in the customer portal, whatever its
650
+ * `portal_visibility`.
651
+ */
652
+ product_line_id?: string;
653
+
654
+ /**
655
+ * Body param: A value expressed as a ratio of two units, supplied on create and
656
+ * update requests.
657
+ *
658
+ * A unit price, for example, has a currency as its numerator unit and the unit the
659
+ * product is bought or sold by as its denominator.
660
+ */
661
+ unit_cost?: MaterialsAPI.RateInput;
662
+
663
+ /**
664
+ * Body param: A value expressed as a ratio of two units, supplied on create and
665
+ * update requests.
666
+ *
667
+ * A unit price, for example, has a currency as its numerator unit and the unit the
668
+ * product is bought or sold by as its denominator.
669
+ */
670
+ unit_price?: MaterialsAPI.RateInput;
671
+ }
672
+
673
+ export interface ProductUpdateParams {
674
+ /**
675
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
676
+ * are returned as `null`.
677
+ */
678
+ include?: Array<
679
+ | 'product_line'
680
+ | 'product_line.unit_group'
681
+ | 'product_line.unit_group.base_unit'
682
+ | 'product_line.unit_group.associated_units'
683
+ | 'product_line.unit_group.associated_units.unit'
684
+ | 'item'
685
+ | 'item.category'
686
+ | 'item.category.properties'
687
+ | 'item.category.unit_group'
688
+ | 'item.category.unit_group.base_unit'
689
+ | 'item.category.unit_group.associated_units'
690
+ | 'item.category.unit_group.associated_units.unit'
691
+ | 'item.unit_value'
692
+ | 'item.unit_cost'
693
+ | 'item.burn_rate'
694
+ | 'item.attributes'
695
+ >;
696
+
697
+ /**
698
+ * Body param: Free-form description of the product.
699
+ *
700
+ * Send `null` to clear.
701
+ */
702
+ description?: string | null;
703
+
704
+ /**
705
+ * Body param: Free-form notes about the product.
706
+ *
707
+ * Send `null` to clear.
708
+ */
709
+ notes?: string | null;
710
+
711
+ /**
712
+ * Body param: Whether the product is shown to buyers in the customer portal.
713
+ *
714
+ * - `visible`: buyers can see and order the product in the portal.
715
+ * - `hidden`: the product is concealed from the portal but remains usable
716
+ * internally.
717
+ */
718
+ portal_visibility?: 'visible' | 'hidden';
719
+
720
+ /**
721
+ * Body param: New stock keeping unit code for the product's item.
722
+ *
723
+ * Must be unique within the account; the update fails with a conflict error if
724
+ * another item already uses it.
725
+ */
726
+ sku?: string;
727
+
728
+ /**
729
+ * Body param: A value expressed as a ratio of two units, supplied on create and
730
+ * update requests.
731
+ *
732
+ * A unit price, for example, has a currency as its numerator unit and the unit the
733
+ * product is bought or sold by as its denominator.
734
+ */
735
+ unit_price?: MaterialsAPI.RateInput;
736
+ }
737
+
738
+ export interface ProductDeleteParams {
739
+ /**
740
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
741
+ * `null`.
742
+ */
743
+ include?: Array<
744
+ | 'product_line'
745
+ | 'product_line.unit_group'
746
+ | 'product_line.unit_group.base_unit'
747
+ | 'product_line.unit_group.associated_units'
748
+ | 'product_line.unit_group.associated_units.unit'
749
+ | 'item'
750
+ | 'item.category'
751
+ | 'item.category.properties'
752
+ | 'item.category.unit_group'
753
+ | 'item.category.unit_group.base_unit'
754
+ | 'item.category.unit_group.associated_units'
755
+ | 'item.category.unit_group.associated_units.unit'
756
+ | 'item.unit_value'
757
+ | 'item.unit_cost'
758
+ | 'item.burn_rate'
759
+ | 'item.attributes'
760
+ >;
761
+ }
762
+
763
+ export interface ProductChangeProductLineParams {
764
+ /**
765
+ * Path param: Product ID.
766
+ */
767
+ id: string;
768
+
769
+ /**
770
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
771
+ * are returned as `null`.
772
+ */
773
+ include?: Array<
774
+ | 'product_line'
775
+ | 'product_line.unit_group'
776
+ | 'product_line.unit_group.base_unit'
777
+ | 'product_line.unit_group.associated_units'
778
+ | 'product_line.unit_group.associated_units.unit'
779
+ | 'item'
780
+ | 'item.category'
781
+ | 'item.category.properties'
782
+ | 'item.category.unit_group'
783
+ | 'item.category.unit_group.base_unit'
784
+ | 'item.category.unit_group.associated_units'
785
+ | 'item.category.unit_group.associated_units.unit'
786
+ | 'item.unit_value'
787
+ | 'item.unit_cost'
788
+ | 'item.burn_rate'
789
+ | 'item.attributes'
790
+ >;
791
+ }
792
+
793
+ Products.Actions = Actions;
794
+
795
+ export declare namespace Products {
796
+ export {
797
+ type CreateProductRequest as CreateProductRequest,
798
+ type ListProduct as ListProduct,
799
+ type Product as Product,
800
+ type UpdateProductRequest as UpdateProductRequest,
801
+ type ProductListParams as ProductListParams,
802
+ type ProductRetrieveParams as ProductRetrieveParams,
803
+ type ProductCreateParams as ProductCreateParams,
804
+ type ProductUpdateParams as ProductUpdateParams,
805
+ type ProductDeleteParams as ProductDeleteParams,
806
+ type ProductChangeProductLineParams as ProductChangeProductLineParams,
807
+ };
808
+
809
+ export {
810
+ Actions as Actions,
811
+ type BulkUpsertProductsRequest as BulkUpsertProductsRequest,
812
+ type UpsertProductInput as UpsertProductInput,
813
+ type UpsertProductProperty as UpsertProductProperty,
814
+ type ActionBulkUpsertParams as ActionBulkUpsertParams,
815
+ };
816
+ }