@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
@@ -6,20 +6,15 @@ import { path } from "../../internal/utils/path.mjs";
6
6
  */
7
7
  export class Products extends APIResource {
8
8
  /**
9
- * Creates a product.
9
+ * Returns a paginated list of products for the target account.
10
10
  *
11
11
  * @example
12
12
  * ```ts
13
- * const product = await client.catalog.products.create({
14
- * category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
15
- * sku: 'ALM-2024-1001',
16
- * type: 'sale',
17
- * });
13
+ * const listProduct = await client.catalog.products.list();
18
14
  * ```
19
15
  */
20
- create(params, options) {
21
- const { include, ...body } = params;
22
- return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
16
+ list(query = {}, options) {
17
+ return this._client.get('/v1/catalog/products', { query, ...options });
23
18
  }
24
19
  /**
25
20
  * Returns a product by ID.
@@ -35,29 +30,39 @@ export class Products extends APIResource {
35
30
  return this._client.get(path `/v1/catalog/products/${id}`, { query, ...options });
36
31
  }
37
32
  /**
38
- * Partially updates a product.
33
+ * Creates a product and its backing inventory item.
34
+ *
35
+ * The new item starts with zero on-hand inventory, and its pricing defaults to
36
+ * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
37
+ * provided.
39
38
  *
40
39
  * @example
41
40
  * ```ts
42
- * const product = await client.catalog.products.update(
43
- * 'pd_013c29ab3f1518d0004094c316',
44
- * );
41
+ * const product = await client.catalog.products.create({
42
+ * category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
43
+ * sku: 'ALM-2024-1001',
44
+ * type: 'sale',
45
+ * });
45
46
  * ```
46
47
  */
47
- update(id, params = {}, options) {
48
- const { include, ...body } = params ?? {};
49
- return this._client.patch(path `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
48
+ create(params, options) {
49
+ const { include, ...body } = params;
50
+ return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
50
51
  }
51
52
  /**
52
- * Returns a paginated list of products for the target account.
53
+ * Partially updates a product.
53
54
  *
54
55
  * @example
55
56
  * ```ts
56
- * const listProduct = await client.catalog.products.list();
57
+ * const product = await client.catalog.products.update(
58
+ * 'pd_013c29ab3f1518d0004094c316',
59
+ * { sku: 'SKU-002' },
60
+ * );
57
61
  * ```
58
62
  */
59
- list(query = {}, options) {
60
- return this._client.get('/v1/catalog/products', { query, ...options });
63
+ update(id, params = {}, options) {
64
+ const { include, ...body } = params ?? {};
65
+ return this._client.patch(path `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
61
66
  }
62
67
  /**
63
68
  * Soft-deletes a product and returns the deleted product.
@@ -1 +1 @@
1
- {"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAOlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAOf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -7,18 +7,17 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
7
7
  */
8
8
  export declare class Attributes extends APIResource {
9
9
  /**
10
- * Creates an attribute under a property.
10
+ * Returns a paginated list of attributes for a property.
11
11
  *
12
12
  * @example
13
13
  * ```ts
14
- * const attribute =
15
- * await client.catalog.properties.attributes.create(
14
+ * const listAttribute =
15
+ * await client.catalog.properties.attributes.list(
16
16
  * 'pp_01e21344878064372f69e67093',
17
- * { value: 'Red' },
18
17
  * );
19
18
  * ```
20
19
  */
21
- create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
20
+ list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
22
21
  /**
23
22
  * Returns an attribute by ID within a property.
24
23
  *
@@ -33,33 +32,44 @@ export declare class Attributes extends APIResource {
33
32
  */
34
33
  retrieve(id: string, params: AttributeRetrieveParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
35
34
  /**
36
- * Partially updates an attribute.
35
+ * Creates an attribute under a property.
37
36
  *
38
37
  * @example
39
38
  * ```ts
40
39
  * const attribute =
41
- * await client.catalog.properties.attributes.update(
42
- * 'at_01c9493ec0c46bb0ed12708ae4',
43
- * { property_id: 'pp_01e21344878064372f69e67093' },
40
+ * await client.catalog.properties.attributes.create(
41
+ * 'pp_01e21344878064372f69e67093',
42
+ * {
43
+ * value: 'Red',
44
+ * color: 'red',
45
+ * sort_order: 1,
46
+ * },
44
47
  * );
45
48
  * ```
46
49
  */
47
- update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
50
+ create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
48
51
  /**
49
- * Returns a paginated list of attributes for a property.
52
+ * Partially updates an attribute.
50
53
  *
51
54
  * @example
52
55
  * ```ts
53
- * const listAttribute =
54
- * await client.catalog.properties.attributes.list(
55
- * 'pp_01e21344878064372f69e67093',
56
+ * const attribute =
57
+ * await client.catalog.properties.attributes.update(
58
+ * 'at_01c9493ec0c46bb0ed12708ae4',
59
+ * {
60
+ * property_id: 'pp_01e21344878064372f69e67093',
61
+ * value: 'Blue',
62
+ * },
56
63
  * );
57
64
  * ```
58
65
  */
59
- list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
66
+ update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
60
67
  /**
61
68
  * Deletes an attribute from a property.
62
69
  *
70
+ * Remaining attributes in the property are shifted so their sort orders stay
71
+ * contiguous.
72
+ *
63
73
  * @example
64
74
  * ```ts
65
75
  * const attribute =
@@ -76,15 +86,26 @@ export declare class Attributes extends APIResource {
76
86
  */
77
87
  export interface CreateAttributeRequest {
78
88
  /**
79
- * Attribute value.
89
+ * The selectable value this attribute represents, such as `Red`.
90
+ *
91
+ * Must be unique across all attributes in the account, not just within the
92
+ * property. Leading and trailing whitespace is trimmed.
80
93
  */
81
94
  value: string;
82
95
  /**
83
- * Color code. Randomly assigned if not provided.
96
+ * Swatch color used to display this attribute in the UI.
97
+ *
98
+ * When omitted, one of the nine named colors (everything except `default`) is
99
+ * assigned at random.
84
100
  */
85
101
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
86
102
  /**
87
- * Display order. Defaults to last position if not provided.
103
+ * Position of the new attribute relative to its siblings within the property,
104
+ * starting at `1`.
105
+ *
106
+ * Must be at most the property's current attribute count plus one; siblings at or
107
+ * after this position are shifted one position later. Defaults to the last
108
+ * position if not provided.
88
109
  */
89
110
  sort_order?: number;
90
111
  }
@@ -93,33 +114,46 @@ export interface CreateAttributeRequest {
93
114
  */
94
115
  export interface UpdateAttributeRequest {
95
116
  /**
96
- * Color code.
117
+ * Swatch color used to display this attribute in the UI.
97
118
  */
98
119
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
99
120
  /**
100
- * Display order. Must be a positive integer.
121
+ * New position of this attribute relative to its siblings within the property,
122
+ * starting at `1`.
123
+ *
124
+ * Must be at most the property's current attribute count; the attributes between
125
+ * the old and new positions shift to make room.
101
126
  */
102
127
  sort_order?: number;
103
128
  /**
104
- * Attribute value.
129
+ * The selectable value this attribute represents, such as `Red`.
130
+ *
131
+ * Must be non-blank and unique across all attributes in the account, not just
132
+ * within the property.
105
133
  */
106
134
  value?: string;
107
135
  }
108
136
  export interface AttributeDeleteResponse {
109
137
  }
110
- export interface AttributeCreateParams {
138
+ export interface AttributeListParams {
111
139
  /**
112
- * Attribute value.
140
+ * Opaque cursor token identifying where the page of results starts.
141
+ *
142
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
143
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
144
+ * page.
113
145
  */
114
- value: string;
146
+ cursor?: string;
115
147
  /**
116
- * Color code. Randomly assigned if not provided.
148
+ * Maximum number of results to return in a single page.
117
149
  */
118
- color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
150
+ limit?: number;
119
151
  /**
120
- * Display order. Defaults to last position if not provided.
152
+ * Free-text search term used to filter results.
153
+ *
154
+ * Which fields are matched against the term varies by endpoint.
121
155
  */
122
- sort_order?: number;
156
+ q?: string;
123
157
  }
124
158
  export interface AttributeRetrieveParams {
125
159
  /**
@@ -127,37 +161,55 @@ export interface AttributeRetrieveParams {
127
161
  */
128
162
  property_id: string;
129
163
  }
130
- export interface AttributeUpdateParams {
164
+ export interface AttributeCreateParams {
131
165
  /**
132
- * Path param: Property ID.
166
+ * The selectable value this attribute represents, such as `Red`.
167
+ *
168
+ * Must be unique across all attributes in the account, not just within the
169
+ * property. Leading and trailing whitespace is trimmed.
133
170
  */
134
- property_id: string;
171
+ value: string;
135
172
  /**
136
- * Body param: Color code.
173
+ * Swatch color used to display this attribute in the UI.
174
+ *
175
+ * When omitted, one of the nine named colors (everything except `default`) is
176
+ * assigned at random.
137
177
  */
138
178
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
139
179
  /**
140
- * Body param: Display order. Must be a positive integer.
180
+ * Position of the new attribute relative to its siblings within the property,
181
+ * starting at `1`.
182
+ *
183
+ * Must be at most the property's current attribute count plus one; siblings at or
184
+ * after this position are shifted one position later. Defaults to the last
185
+ * position if not provided.
141
186
  */
142
187
  sort_order?: number;
188
+ }
189
+ export interface AttributeUpdateParams {
143
190
  /**
144
- * Body param: Attribute value.
191
+ * Path param: Property ID.
145
192
  */
146
- value?: string;
147
- }
148
- export interface AttributeListParams {
193
+ property_id: string;
149
194
  /**
150
- * Cursor token used to retrieve the next or previous page of results.
195
+ * Body param: Swatch color used to display this attribute in the UI.
151
196
  */
152
- cursor?: string;
197
+ color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
153
198
  /**
154
- * Maximum number of results per page (default: 100, max: 1000).
199
+ * Body param: New position of this attribute relative to its siblings within the
200
+ * property, starting at `1`.
201
+ *
202
+ * Must be at most the property's current attribute count; the attributes between
203
+ * the old and new positions shift to make room.
155
204
  */
156
- limit?: number;
205
+ sort_order?: number;
157
206
  /**
158
- * Search query used to filter results.
207
+ * Body param: The selectable value this attribute represents, such as `Red`.
208
+ *
209
+ * Must be non-blank and unique across all attributes in the account, not just
210
+ * within the property.
159
211
  */
160
- q?: string;
212
+ value?: string;
161
213
  }
162
214
  export interface AttributeDeleteParams {
163
215
  /**
@@ -166,6 +218,6 @@ export interface AttributeDeleteParams {
166
218
  property_id: string;
167
219
  }
168
220
  export declare namespace Attributes {
169
- export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeCreateParams as AttributeCreateParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeListParams as AttributeListParams, type AttributeDeleteParams as AttributeDeleteParams, };
221
+ export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeListParams as AttributeListParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeCreateParams as AttributeCreateParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
170
222
  }
171
223
  //# sourceMappingURL=attributes.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;OAUG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
1
+ {"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -7,18 +7,17 @@ import { RequestOptions } from "../../../internal/request-options.js";
7
7
  */
8
8
  export declare class Attributes extends APIResource {
9
9
  /**
10
- * Creates an attribute under a property.
10
+ * Returns a paginated list of attributes for a property.
11
11
  *
12
12
  * @example
13
13
  * ```ts
14
- * const attribute =
15
- * await client.catalog.properties.attributes.create(
14
+ * const listAttribute =
15
+ * await client.catalog.properties.attributes.list(
16
16
  * 'pp_01e21344878064372f69e67093',
17
- * { value: 'Red' },
18
17
  * );
19
18
  * ```
20
19
  */
21
- create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
20
+ list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
22
21
  /**
23
22
  * Returns an attribute by ID within a property.
24
23
  *
@@ -33,33 +32,44 @@ export declare class Attributes extends APIResource {
33
32
  */
34
33
  retrieve(id: string, params: AttributeRetrieveParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
35
34
  /**
36
- * Partially updates an attribute.
35
+ * Creates an attribute under a property.
37
36
  *
38
37
  * @example
39
38
  * ```ts
40
39
  * const attribute =
41
- * await client.catalog.properties.attributes.update(
42
- * 'at_01c9493ec0c46bb0ed12708ae4',
43
- * { property_id: 'pp_01e21344878064372f69e67093' },
40
+ * await client.catalog.properties.attributes.create(
41
+ * 'pp_01e21344878064372f69e67093',
42
+ * {
43
+ * value: 'Red',
44
+ * color: 'red',
45
+ * sort_order: 1,
46
+ * },
44
47
  * );
45
48
  * ```
46
49
  */
47
- update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
50
+ create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
48
51
  /**
49
- * Returns a paginated list of attributes for a property.
52
+ * Partially updates an attribute.
50
53
  *
51
54
  * @example
52
55
  * ```ts
53
- * const listAttribute =
54
- * await client.catalog.properties.attributes.list(
55
- * 'pp_01e21344878064372f69e67093',
56
+ * const attribute =
57
+ * await client.catalog.properties.attributes.update(
58
+ * 'at_01c9493ec0c46bb0ed12708ae4',
59
+ * {
60
+ * property_id: 'pp_01e21344878064372f69e67093',
61
+ * value: 'Blue',
62
+ * },
56
63
  * );
57
64
  * ```
58
65
  */
59
- list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
66
+ update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
60
67
  /**
61
68
  * Deletes an attribute from a property.
62
69
  *
70
+ * Remaining attributes in the property are shifted so their sort orders stay
71
+ * contiguous.
72
+ *
63
73
  * @example
64
74
  * ```ts
65
75
  * const attribute =
@@ -76,15 +86,26 @@ export declare class Attributes extends APIResource {
76
86
  */
77
87
  export interface CreateAttributeRequest {
78
88
  /**
79
- * Attribute value.
89
+ * The selectable value this attribute represents, such as `Red`.
90
+ *
91
+ * Must be unique across all attributes in the account, not just within the
92
+ * property. Leading and trailing whitespace is trimmed.
80
93
  */
81
94
  value: string;
82
95
  /**
83
- * Color code. Randomly assigned if not provided.
96
+ * Swatch color used to display this attribute in the UI.
97
+ *
98
+ * When omitted, one of the nine named colors (everything except `default`) is
99
+ * assigned at random.
84
100
  */
85
101
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
86
102
  /**
87
- * Display order. Defaults to last position if not provided.
103
+ * Position of the new attribute relative to its siblings within the property,
104
+ * starting at `1`.
105
+ *
106
+ * Must be at most the property's current attribute count plus one; siblings at or
107
+ * after this position are shifted one position later. Defaults to the last
108
+ * position if not provided.
88
109
  */
89
110
  sort_order?: number;
90
111
  }
@@ -93,33 +114,46 @@ export interface CreateAttributeRequest {
93
114
  */
94
115
  export interface UpdateAttributeRequest {
95
116
  /**
96
- * Color code.
117
+ * Swatch color used to display this attribute in the UI.
97
118
  */
98
119
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
99
120
  /**
100
- * Display order. Must be a positive integer.
121
+ * New position of this attribute relative to its siblings within the property,
122
+ * starting at `1`.
123
+ *
124
+ * Must be at most the property's current attribute count; the attributes between
125
+ * the old and new positions shift to make room.
101
126
  */
102
127
  sort_order?: number;
103
128
  /**
104
- * Attribute value.
129
+ * The selectable value this attribute represents, such as `Red`.
130
+ *
131
+ * Must be non-blank and unique across all attributes in the account, not just
132
+ * within the property.
105
133
  */
106
134
  value?: string;
107
135
  }
108
136
  export interface AttributeDeleteResponse {
109
137
  }
110
- export interface AttributeCreateParams {
138
+ export interface AttributeListParams {
111
139
  /**
112
- * Attribute value.
140
+ * Opaque cursor token identifying where the page of results starts.
141
+ *
142
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
143
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
144
+ * page.
113
145
  */
114
- value: string;
146
+ cursor?: string;
115
147
  /**
116
- * Color code. Randomly assigned if not provided.
148
+ * Maximum number of results to return in a single page.
117
149
  */
118
- color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
150
+ limit?: number;
119
151
  /**
120
- * Display order. Defaults to last position if not provided.
152
+ * Free-text search term used to filter results.
153
+ *
154
+ * Which fields are matched against the term varies by endpoint.
121
155
  */
122
- sort_order?: number;
156
+ q?: string;
123
157
  }
124
158
  export interface AttributeRetrieveParams {
125
159
  /**
@@ -127,37 +161,55 @@ export interface AttributeRetrieveParams {
127
161
  */
128
162
  property_id: string;
129
163
  }
130
- export interface AttributeUpdateParams {
164
+ export interface AttributeCreateParams {
131
165
  /**
132
- * Path param: Property ID.
166
+ * The selectable value this attribute represents, such as `Red`.
167
+ *
168
+ * Must be unique across all attributes in the account, not just within the
169
+ * property. Leading and trailing whitespace is trimmed.
133
170
  */
134
- property_id: string;
171
+ value: string;
135
172
  /**
136
- * Body param: Color code.
173
+ * Swatch color used to display this attribute in the UI.
174
+ *
175
+ * When omitted, one of the nine named colors (everything except `default`) is
176
+ * assigned at random.
137
177
  */
138
178
  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
139
179
  /**
140
- * Body param: Display order. Must be a positive integer.
180
+ * Position of the new attribute relative to its siblings within the property,
181
+ * starting at `1`.
182
+ *
183
+ * Must be at most the property's current attribute count plus one; siblings at or
184
+ * after this position are shifted one position later. Defaults to the last
185
+ * position if not provided.
141
186
  */
142
187
  sort_order?: number;
188
+ }
189
+ export interface AttributeUpdateParams {
143
190
  /**
144
- * Body param: Attribute value.
191
+ * Path param: Property ID.
145
192
  */
146
- value?: string;
147
- }
148
- export interface AttributeListParams {
193
+ property_id: string;
149
194
  /**
150
- * Cursor token used to retrieve the next or previous page of results.
195
+ * Body param: Swatch color used to display this attribute in the UI.
151
196
  */
152
- cursor?: string;
197
+ color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
153
198
  /**
154
- * Maximum number of results per page (default: 100, max: 1000).
199
+ * Body param: New position of this attribute relative to its siblings within the
200
+ * property, starting at `1`.
201
+ *
202
+ * Must be at most the property's current attribute count; the attributes between
203
+ * the old and new positions shift to make room.
155
204
  */
156
- limit?: number;
205
+ sort_order?: number;
157
206
  /**
158
- * Search query used to filter results.
207
+ * Body param: The selectable value this attribute represents, such as `Red`.
208
+ *
209
+ * Must be non-blank and unique across all attributes in the account, not just
210
+ * within the property.
159
211
  */
160
- q?: string;
212
+ value?: string;
161
213
  }
162
214
  export interface AttributeDeleteParams {
163
215
  /**
@@ -166,6 +218,6 @@ export interface AttributeDeleteParams {
166
218
  property_id: string;
167
219
  }
168
220
  export declare namespace Attributes {
169
- export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeCreateParams as AttributeCreateParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeListParams as AttributeListParams, type AttributeDeleteParams as AttributeDeleteParams, };
221
+ export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeListParams as AttributeListParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeCreateParams as AttributeCreateParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
170
222
  }
171
223
  //# sourceMappingURL=attributes.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;OAUG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
1
+ {"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}