@augno/sdk 0.1.9 → 0.7.1

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 (1074) 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 +15 -3
  10. package/client.d.mts.map +1 -1
  11. package/client.d.ts +15 -3
  12. package/client.d.ts.map +1 -1
  13. package/client.js +18 -1
  14. package/client.js.map +1 -1
  15. package/client.mjs +18 -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 +28 -5
  86. package/resources/auth/api-keys/actions.d.mts.map +1 -1
  87. package/resources/auth/api-keys/actions.d.ts +28 -5
  88. package/resources/auth/api-keys/actions.d.ts.map +1 -1
  89. package/resources/auth/api-keys/actions.js +6 -1
  90. package/resources/auth/api-keys/actions.js.map +1 -1
  91. package/resources/auth/api-keys/actions.mjs +6 -1
  92. package/resources/auth/api-keys/actions.mjs.map +1 -1
  93. package/resources/auth/api-keys/api-keys.d.mts +144 -72
  94. package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
  95. package/resources/auth/api-keys/api-keys.d.ts +144 -72
  96. package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
  97. package/resources/auth/api-keys/api-keys.js +32 -22
  98. package/resources/auth/api-keys/api-keys.js.map +1 -1
  99. package/resources/auth/api-keys/api-keys.mjs +32 -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 +107 -65
  138. package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
  139. package/resources/catalog/item-categories/item-categories.d.ts +107 -65
  140. package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
  141. package/resources/catalog/item-categories/item-categories.js +50 -30
  142. package/resources/catalog/item-categories/item-categories.js.map +1 -1
  143. package/resources/catalog/item-categories/item-categories.mjs +50 -30
  144. package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
  145. package/resources/catalog/item-categories/properties.d.mts +13 -4
  146. package/resources/catalog/item-categories/properties.d.mts.map +1 -1
  147. package/resources/catalog/item-categories/properties.d.ts +13 -4
  148. package/resources/catalog/item-categories/properties.d.ts.map +1 -1
  149. package/resources/catalog/item-categories/properties.js +13 -4
  150. package/resources/catalog/item-categories/properties.js.map +1 -1
  151. package/resources/catalog/item-categories/properties.mjs +13 -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 +7 -2
  157. package/resources/catalog/items/attributes.d.mts.map +1 -1
  158. package/resources/catalog/items/attributes.d.ts +7 -2
  159. package/resources/catalog/items/attributes.d.ts.map +1 -1
  160. package/resources/catalog/items/attributes.js +7 -2
  161. package/resources/catalog/items/attributes.js.map +1 -1
  162. package/resources/catalog/items/attributes.mjs +7 -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 +96 -52
  170. package/resources/catalog/items/items.d.mts.map +1 -1
  171. package/resources/catalog/items/items.d.ts +96 -52
  172. package/resources/catalog/items/items.d.ts.map +1 -1
  173. package/resources/catalog/items/items.js +32 -21
  174. package/resources/catalog/items/items.js.map +1 -1
  175. package/resources/catalog/items/items.mjs +32 -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 +156 -94
  181. package/resources/catalog/materials.d.mts.map +1 -1
  182. package/resources/catalog/materials.d.ts +156 -94
  183. package/resources/catalog/materials.d.ts.map +1 -1
  184. package/resources/catalog/materials.js +44 -19
  185. package/resources/catalog/materials.js.map +1 -1
  186. package/resources/catalog/materials.mjs +44 -19
  187. package/resources/catalog/materials.mjs.map +1 -1
  188. package/resources/catalog/parts.d.mts +142 -74
  189. package/resources/catalog/parts.d.mts.map +1 -1
  190. package/resources/catalog/parts.d.ts +142 -74
  191. package/resources/catalog/parts.d.ts.map +1 -1
  192. package/resources/catalog/parts.js +49 -20
  193. package/resources/catalog/parts.js.map +1 -1
  194. package/resources/catalog/parts.mjs +49 -20
  195. package/resources/catalog/parts.mjs.map +1 -1
  196. package/resources/catalog/product-lines.d.mts +157 -70
  197. package/resources/catalog/product-lines.d.mts.map +1 -1
  198. package/resources/catalog/product-lines.d.ts +157 -70
  199. package/resources/catalog/product-lines.d.ts.map +1 -1
  200. package/resources/catalog/product-lines.js +43 -26
  201. package/resources/catalog/product-lines.js.map +1 -1
  202. package/resources/catalog/product-lines.mjs +43 -26
  203. package/resources/catalog/product-lines.mjs.map +1 -1
  204. package/resources/catalog/products.d.mts +205 -94
  205. package/resources/catalog/products.d.mts.map +1 -1
  206. package/resources/catalog/products.d.ts +205 -94
  207. package/resources/catalog/products.d.ts.map +1 -1
  208. package/resources/catalog/products.js +39 -20
  209. package/resources/catalog/products.js.map +1 -1
  210. package/resources/catalog/products.mjs +39 -20
  211. package/resources/catalog/products.mjs.map +1 -1
  212. package/resources/catalog/properties/attributes.d.mts +106 -44
  213. package/resources/catalog/properties/attributes.d.mts.map +1 -1
  214. package/resources/catalog/properties/attributes.d.ts +106 -44
  215. package/resources/catalog/properties/attributes.d.ts.map +1 -1
  216. package/resources/catalog/properties/attributes.js +41 -21
  217. package/resources/catalog/properties/attributes.js.map +1 -1
  218. package/resources/catalog/properties/attributes.mjs +41 -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 +80 -47
  226. package/resources/catalog/properties/properties.d.mts.map +1 -1
  227. package/resources/catalog/properties/properties.d.ts +80 -47
  228. package/resources/catalog/properties/properties.d.ts.map +1 -1
  229. package/resources/catalog/properties/properties.js +29 -18
  230. package/resources/catalog/properties/properties.js.map +1 -1
  231. package/resources/catalog/properties/properties.mjs +29 -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 +144 -86
  242. package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
  243. package/resources/catalog/unit-groups/unit-groups.d.ts +144 -86
  244. package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
  245. package/resources/catalog/unit-groups/unit-groups.js +44 -25
  246. package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
  247. package/resources/catalog/unit-groups/unit-groups.mjs +44 -25
  248. package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
  249. package/resources/catalog/unit-groups/units.d.mts +88 -54
  250. package/resources/catalog/unit-groups/units.d.mts.map +1 -1
  251. package/resources/catalog/unit-groups/units.d.ts +88 -54
  252. package/resources/catalog/unit-groups/units.d.ts.map +1 -1
  253. package/resources/catalog/unit-groups/units.js +44 -25
  254. package/resources/catalog/unit-groups/units.js.map +1 -1
  255. package/resources/catalog/unit-groups/units.mjs +44 -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 +145 -85
  261. package/resources/catalog/units.d.mts.map +1 -1
  262. package/resources/catalog/units.d.ts +145 -85
  263. package/resources/catalog/units.d.ts.map +1 -1
  264. package/resources/catalog/units.js +39 -26
  265. package/resources/catalog/units.js.map +1 -1
  266. package/resources/catalog/units.mjs +39 -26
  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 +96 -37
  289. package/resources/core/audit-events.d.mts.map +1 -1
  290. package/resources/core/audit-events.d.ts +96 -37
  291. package/resources/core/audit-events.d.ts.map +1 -1
  292. package/resources/core/audit-events.js +19 -10
  293. package/resources/core/audit-events.js.map +1 -1
  294. package/resources/core/audit-events.mjs +19 -10
  295. package/resources/core/audit-events.mjs.map +1 -1
  296. package/resources/core/core.d.mts +107 -4
  297. package/resources/core/core.d.mts.map +1 -1
  298. package/resources/core/core.d.ts +107 -4
  299. package/resources/core/core.d.ts.map +1 -1
  300. package/resources/core/core.js +19 -0
  301. package/resources/core/core.js.map +1 -1
  302. package/resources/core/core.mjs +19 -0
  303. package/resources/core/core.mjs.map +1 -1
  304. package/resources/core/email-logs.d.mts +37 -22
  305. package/resources/core/email-logs.d.mts.map +1 -1
  306. package/resources/core/email-logs.d.ts +37 -22
  307. package/resources/core/email-logs.d.ts.map +1 -1
  308. package/resources/core/email-logs.js +14 -10
  309. package/resources/core/email-logs.js.map +1 -1
  310. package/resources/core/email-logs.mjs +14 -10
  311. package/resources/core/email-logs.mjs.map +1 -1
  312. package/resources/core/index.d.mts +5 -5
  313. package/resources/core/index.d.mts.map +1 -1
  314. package/resources/core/index.d.ts +5 -5
  315. package/resources/core/index.d.ts.map +1 -1
  316. package/resources/core/index.js.map +1 -1
  317. package/resources/core/index.mjs.map +1 -1
  318. package/resources/core/request-logs.d.mts +107 -54
  319. package/resources/core/request-logs.d.mts.map +1 -1
  320. package/resources/core/request-logs.d.ts +107 -54
  321. package/resources/core/request-logs.d.ts.map +1 -1
  322. package/resources/core/request-logs.js +14 -10
  323. package/resources/core/request-logs.js.map +1 -1
  324. package/resources/core/request-logs.mjs +14 -10
  325. package/resources/core/request-logs.mjs.map +1 -1
  326. package/resources/core/sandboxes.d.mts +62 -33
  327. package/resources/core/sandboxes.d.mts.map +1 -1
  328. package/resources/core/sandboxes.d.ts +62 -33
  329. package/resources/core/sandboxes.d.ts.map +1 -1
  330. package/resources/core/sandboxes.js +28 -13
  331. package/resources/core/sandboxes.js.map +1 -1
  332. package/resources/core/sandboxes.mjs +28 -13
  333. package/resources/core/sandboxes.mjs.map +1 -1
  334. package/resources/core.d.mts.map +1 -1
  335. package/resources/core.d.ts.map +1 -1
  336. package/resources/core.mjs.map +1 -1
  337. package/resources/finance/finance.d.mts +69 -35
  338. package/resources/finance/finance.d.mts.map +1 -1
  339. package/resources/finance/finance.d.ts +69 -35
  340. package/resources/finance/finance.d.ts.map +1 -1
  341. package/resources/finance/finance.js +10 -10
  342. package/resources/finance/finance.js.map +1 -1
  343. package/resources/finance/finance.mjs +10 -10
  344. package/resources/finance/finance.mjs.map +1 -1
  345. package/resources/finance/index.d.mts +2 -2
  346. package/resources/finance/index.d.mts.map +1 -1
  347. package/resources/finance/index.d.ts +2 -2
  348. package/resources/finance/index.d.ts.map +1 -1
  349. package/resources/finance/index.mjs.map +1 -1
  350. package/resources/finance/payment-terms.d.mts +82 -43
  351. package/resources/finance/payment-terms.d.mts.map +1 -1
  352. package/resources/finance/payment-terms.d.ts +82 -43
  353. package/resources/finance/payment-terms.d.ts.map +1 -1
  354. package/resources/finance/payment-terms.js +43 -22
  355. package/resources/finance/payment-terms.js.map +1 -1
  356. package/resources/finance/payment-terms.mjs +43 -22
  357. package/resources/finance/payment-terms.mjs.map +1 -1
  358. package/resources/finance.d.mts.map +1 -1
  359. package/resources/finance.d.ts.map +1 -1
  360. package/resources/finance.mjs.map +1 -1
  361. package/resources/identity/account-users/account-users.d.mts +181 -82
  362. package/resources/identity/account-users/account-users.d.mts.map +1 -1
  363. package/resources/identity/account-users/account-users.d.ts +181 -82
  364. package/resources/identity/account-users/account-users.d.ts.map +1 -1
  365. package/resources/identity/account-users/account-users.js +55 -25
  366. package/resources/identity/account-users/account-users.js.map +1 -1
  367. package/resources/identity/account-users/account-users.mjs +55 -25
  368. package/resources/identity/account-users/account-users.mjs.map +1 -1
  369. package/resources/identity/account-users/actions.d.mts +22 -3
  370. package/resources/identity/account-users/actions.d.mts.map +1 -1
  371. package/resources/identity/account-users/actions.d.ts +22 -3
  372. package/resources/identity/account-users/actions.d.ts.map +1 -1
  373. package/resources/identity/account-users/actions.js +22 -3
  374. package/resources/identity/account-users/actions.js.map +1 -1
  375. package/resources/identity/account-users/actions.mjs +22 -3
  376. package/resources/identity/account-users/actions.mjs.map +1 -1
  377. package/resources/identity/account-users/index.d.mts +1 -1
  378. package/resources/identity/account-users/index.d.mts.map +1 -1
  379. package/resources/identity/account-users/index.d.ts +1 -1
  380. package/resources/identity/account-users/index.d.ts.map +1 -1
  381. package/resources/identity/account-users/index.mjs.map +1 -1
  382. package/resources/identity/account-users.d.mts.map +1 -1
  383. package/resources/identity/account-users.d.ts.map +1 -1
  384. package/resources/identity/account-users.mjs.map +1 -1
  385. package/resources/identity/identity.d.mts +2 -2
  386. package/resources/identity/identity.d.mts.map +1 -1
  387. package/resources/identity/identity.d.ts +2 -2
  388. package/resources/identity/identity.d.ts.map +1 -1
  389. package/resources/identity/identity.mjs.map +1 -1
  390. package/resources/identity/index.d.mts +2 -2
  391. package/resources/identity/index.d.mts.map +1 -1
  392. package/resources/identity/index.d.ts +2 -2
  393. package/resources/identity/index.d.ts.map +1 -1
  394. package/resources/identity/index.mjs.map +1 -1
  395. package/resources/identity/roles.d.mts +103 -60
  396. package/resources/identity/roles.d.mts.map +1 -1
  397. package/resources/identity/roles.d.ts +103 -60
  398. package/resources/identity/roles.d.ts.map +1 -1
  399. package/resources/identity/roles.js +47 -27
  400. package/resources/identity/roles.js.map +1 -1
  401. package/resources/identity/roles.mjs +47 -27
  402. package/resources/identity/roles.mjs.map +1 -1
  403. package/resources/identity.d.mts.map +1 -1
  404. package/resources/identity.d.ts.map +1 -1
  405. package/resources/identity.mjs.map +1 -1
  406. package/resources/index.d.mts +4 -2
  407. package/resources/index.d.mts.map +1 -1
  408. package/resources/index.d.ts +4 -2
  409. package/resources/index.d.ts.map +1 -1
  410. package/resources/index.js +5 -1
  411. package/resources/index.js.map +1 -1
  412. package/resources/index.mjs +2 -0
  413. package/resources/index.mjs.map +1 -1
  414. package/resources/messaging/announcements/actions.d.mts +76 -0
  415. package/resources/messaging/announcements/actions.d.mts.map +1 -0
  416. package/resources/messaging/announcements/actions.d.ts +76 -0
  417. package/resources/messaging/announcements/actions.d.ts.map +1 -0
  418. package/resources/messaging/announcements/actions.js +73 -0
  419. package/resources/messaging/announcements/actions.js.map +1 -0
  420. package/resources/messaging/announcements/actions.mjs +69 -0
  421. package/resources/messaging/announcements/actions.mjs.map +1 -0
  422. package/resources/messaging/announcements/announcements.d.mts +173 -0
  423. package/resources/messaging/announcements/announcements.d.mts.map +1 -0
  424. package/resources/messaging/announcements/announcements.d.ts +173 -0
  425. package/resources/messaging/announcements/announcements.d.ts.map +1 -0
  426. package/resources/messaging/announcements/announcements.js +52 -0
  427. package/resources/messaging/announcements/announcements.js.map +1 -0
  428. package/resources/messaging/announcements/announcements.mjs +47 -0
  429. package/resources/messaging/announcements/announcements.mjs.map +1 -0
  430. package/resources/messaging/announcements/index.d.mts +3 -0
  431. package/resources/messaging/announcements/index.d.mts.map +1 -0
  432. package/resources/messaging/announcements/index.d.ts +3 -0
  433. package/resources/messaging/announcements/index.d.ts.map +1 -0
  434. package/resources/messaging/announcements/index.js +9 -0
  435. package/resources/messaging/announcements/index.js.map +1 -0
  436. package/resources/messaging/announcements/index.mjs +4 -0
  437. package/resources/messaging/announcements/index.mjs.map +1 -0
  438. package/resources/messaging/announcements.d.mts +2 -0
  439. package/resources/messaging/announcements.d.mts.map +1 -0
  440. package/resources/messaging/announcements.d.ts +2 -0
  441. package/resources/messaging/announcements.d.ts.map +1 -0
  442. package/resources/messaging/announcements.js +6 -0
  443. package/resources/messaging/announcements.js.map +1 -0
  444. package/resources/messaging/announcements.mjs +3 -0
  445. package/resources/messaging/announcements.mjs.map +1 -0
  446. package/resources/messaging/blocks.d.mts +674 -0
  447. package/resources/messaging/blocks.d.mts.map +1 -0
  448. package/resources/messaging/blocks.d.ts +674 -0
  449. package/resources/messaging/blocks.d.ts.map +1 -0
  450. package/resources/messaging/blocks.js +61 -0
  451. package/resources/messaging/blocks.js.map +1 -0
  452. package/resources/messaging/blocks.mjs +57 -0
  453. package/resources/messaging/blocks.mjs.map +1 -0
  454. package/resources/messaging/conversations/actions.d.mts +422 -0
  455. package/resources/messaging/conversations/actions.d.mts.map +1 -0
  456. package/resources/messaging/conversations/actions.d.ts +422 -0
  457. package/resources/messaging/conversations/actions.d.ts.map +1 -0
  458. package/resources/messaging/conversations/actions.js +299 -0
  459. package/resources/messaging/conversations/actions.js.map +1 -0
  460. package/resources/messaging/conversations/actions.mjs +295 -0
  461. package/resources/messaging/conversations/actions.mjs.map +1 -0
  462. package/resources/messaging/conversations/attachments/actions.d.mts +87 -0
  463. package/resources/messaging/conversations/attachments/actions.d.mts.map +1 -0
  464. package/resources/messaging/conversations/attachments/actions.d.ts +87 -0
  465. package/resources/messaging/conversations/attachments/actions.d.ts.map +1 -0
  466. package/resources/messaging/conversations/attachments/actions.js +36 -0
  467. package/resources/messaging/conversations/attachments/actions.js.map +1 -0
  468. package/resources/messaging/conversations/attachments/actions.mjs +32 -0
  469. package/resources/messaging/conversations/attachments/actions.mjs.map +1 -0
  470. package/resources/messaging/conversations/attachments/attachments.d.mts +10 -0
  471. package/resources/messaging/conversations/attachments/attachments.d.mts.map +1 -0
  472. package/resources/messaging/conversations/attachments/attachments.d.ts +10 -0
  473. package/resources/messaging/conversations/attachments/attachments.d.ts.map +1 -0
  474. package/resources/messaging/conversations/attachments/attachments.js +17 -0
  475. package/resources/messaging/conversations/attachments/attachments.js.map +1 -0
  476. package/resources/messaging/conversations/attachments/attachments.mjs +12 -0
  477. package/resources/messaging/conversations/attachments/attachments.mjs.map +1 -0
  478. package/resources/messaging/conversations/attachments/index.d.mts +3 -0
  479. package/resources/messaging/conversations/attachments/index.d.mts.map +1 -0
  480. package/resources/messaging/conversations/attachments/index.d.ts +3 -0
  481. package/resources/messaging/conversations/attachments/index.d.ts.map +1 -0
  482. package/resources/messaging/conversations/attachments/index.js +9 -0
  483. package/resources/messaging/conversations/attachments/index.js.map +1 -0
  484. package/resources/messaging/conversations/attachments/index.mjs +4 -0
  485. package/resources/messaging/conversations/attachments/index.mjs.map +1 -0
  486. package/resources/messaging/conversations/attachments.d.mts +2 -0
  487. package/resources/messaging/conversations/attachments.d.mts.map +1 -0
  488. package/resources/messaging/conversations/attachments.d.ts +2 -0
  489. package/resources/messaging/conversations/attachments.d.ts.map +1 -0
  490. package/resources/messaging/conversations/attachments.js +6 -0
  491. package/resources/messaging/conversations/attachments.js.map +1 -0
  492. package/resources/messaging/conversations/attachments.mjs +3 -0
  493. package/resources/messaging/conversations/attachments.mjs.map +1 -0
  494. package/resources/messaging/conversations/conversations.d.mts +1328 -0
  495. package/resources/messaging/conversations/conversations.d.mts.map +1 -0
  496. package/resources/messaging/conversations/conversations.d.ts +1328 -0
  497. package/resources/messaging/conversations/conversations.d.ts.map +1 -0
  498. package/resources/messaging/conversations/conversations.js +109 -0
  499. package/resources/messaging/conversations/conversations.js.map +1 -0
  500. package/resources/messaging/conversations/conversations.mjs +104 -0
  501. package/resources/messaging/conversations/conversations.mjs.map +1 -0
  502. package/resources/messaging/conversations/index.d.mts +7 -0
  503. package/resources/messaging/conversations/index.d.mts.map +1 -0
  504. package/resources/messaging/conversations/index.d.ts +7 -0
  505. package/resources/messaging/conversations/index.d.ts.map +1 -0
  506. package/resources/messaging/conversations/index.js +17 -0
  507. package/resources/messaging/conversations/index.js.map +1 -0
  508. package/resources/messaging/conversations/index.mjs +8 -0
  509. package/resources/messaging/conversations/index.mjs.map +1 -0
  510. package/resources/messaging/conversations/links.d.mts +149 -0
  511. package/resources/messaging/conversations/links.d.mts.map +1 -0
  512. package/resources/messaging/conversations/links.d.ts +149 -0
  513. package/resources/messaging/conversations/links.d.ts.map +1 -0
  514. package/resources/messaging/conversations/links.js +72 -0
  515. package/resources/messaging/conversations/links.js.map +1 -0
  516. package/resources/messaging/conversations/links.mjs +68 -0
  517. package/resources/messaging/conversations/links.mjs.map +1 -0
  518. package/resources/messaging/conversations/messages.d.mts +332 -0
  519. package/resources/messaging/conversations/messages.d.mts.map +1 -0
  520. package/resources/messaging/conversations/messages.d.ts +332 -0
  521. package/resources/messaging/conversations/messages.d.ts.map +1 -0
  522. package/resources/messaging/conversations/messages.js +60 -0
  523. package/resources/messaging/conversations/messages.js.map +1 -0
  524. package/resources/messaging/conversations/messages.mjs +56 -0
  525. package/resources/messaging/conversations/messages.mjs.map +1 -0
  526. package/resources/messaging/conversations/participants/actions.d.mts +62 -0
  527. package/resources/messaging/conversations/participants/actions.d.mts.map +1 -0
  528. package/resources/messaging/conversations/participants/actions.d.ts +62 -0
  529. package/resources/messaging/conversations/participants/actions.d.ts.map +1 -0
  530. package/resources/messaging/conversations/participants/actions.js +35 -0
  531. package/resources/messaging/conversations/participants/actions.js.map +1 -0
  532. package/resources/messaging/conversations/participants/actions.mjs +31 -0
  533. package/resources/messaging/conversations/participants/actions.mjs.map +1 -0
  534. package/resources/messaging/conversations/participants/index.d.mts +3 -0
  535. package/resources/messaging/conversations/participants/index.d.mts.map +1 -0
  536. package/resources/messaging/conversations/participants/index.d.ts +3 -0
  537. package/resources/messaging/conversations/participants/index.d.ts.map +1 -0
  538. package/resources/messaging/conversations/participants/index.js +9 -0
  539. package/resources/messaging/conversations/participants/index.js.map +1 -0
  540. package/resources/messaging/conversations/participants/index.mjs +4 -0
  541. package/resources/messaging/conversations/participants/index.mjs.map +1 -0
  542. package/resources/messaging/conversations/participants/participants.d.mts +100 -0
  543. package/resources/messaging/conversations/participants/participants.d.mts.map +1 -0
  544. package/resources/messaging/conversations/participants/participants.d.ts +100 -0
  545. package/resources/messaging/conversations/participants/participants.d.ts.map +1 -0
  546. package/resources/messaging/conversations/participants/participants.js +64 -0
  547. package/resources/messaging/conversations/participants/participants.js.map +1 -0
  548. package/resources/messaging/conversations/participants/participants.mjs +59 -0
  549. package/resources/messaging/conversations/participants/participants.mjs.map +1 -0
  550. package/resources/messaging/conversations/participants.d.mts +2 -0
  551. package/resources/messaging/conversations/participants.d.mts.map +1 -0
  552. package/resources/messaging/conversations/participants.d.ts +2 -0
  553. package/resources/messaging/conversations/participants.d.ts.map +1 -0
  554. package/resources/messaging/conversations/participants.js +6 -0
  555. package/resources/messaging/conversations/participants.js.map +1 -0
  556. package/resources/messaging/conversations/participants.mjs +3 -0
  557. package/resources/messaging/conversations/participants.mjs.map +1 -0
  558. package/resources/messaging/conversations.d.mts +2 -0
  559. package/resources/messaging/conversations.d.mts.map +1 -0
  560. package/resources/messaging/conversations.d.ts +2 -0
  561. package/resources/messaging/conversations.d.ts.map +1 -0
  562. package/resources/messaging/conversations.js +6 -0
  563. package/resources/messaging/conversations.js.map +1 -0
  564. package/resources/messaging/conversations.mjs +3 -0
  565. package/resources/messaging/conversations.mjs.map +1 -0
  566. package/resources/messaging/email-domains/actions.d.mts +27 -0
  567. package/resources/messaging/email-domains/actions.d.mts.map +1 -0
  568. package/resources/messaging/email-domains/actions.d.ts +27 -0
  569. package/resources/messaging/email-domains/actions.d.ts.map +1 -0
  570. package/resources/messaging/email-domains/actions.js +32 -0
  571. package/resources/messaging/email-domains/actions.js.map +1 -0
  572. package/resources/messaging/email-domains/actions.mjs +28 -0
  573. package/resources/messaging/email-domains/actions.mjs.map +1 -0
  574. package/resources/messaging/email-domains/email-domains.d.mts +136 -0
  575. package/resources/messaging/email-domains/email-domains.d.mts.map +1 -0
  576. package/resources/messaging/email-domains/email-domains.d.ts +136 -0
  577. package/resources/messaging/email-domains/email-domains.d.ts.map +1 -0
  578. package/resources/messaging/email-domains/email-domains.js +70 -0
  579. package/resources/messaging/email-domains/email-domains.js.map +1 -0
  580. package/resources/messaging/email-domains/email-domains.mjs +65 -0
  581. package/resources/messaging/email-domains/email-domains.mjs.map +1 -0
  582. package/resources/messaging/email-domains/index.d.mts +3 -0
  583. package/resources/messaging/email-domains/index.d.mts.map +1 -0
  584. package/resources/messaging/email-domains/index.d.ts +3 -0
  585. package/resources/messaging/email-domains/index.d.ts.map +1 -0
  586. package/resources/messaging/email-domains/index.js +9 -0
  587. package/resources/messaging/email-domains/index.js.map +1 -0
  588. package/resources/messaging/email-domains/index.mjs +4 -0
  589. package/resources/messaging/email-domains/index.mjs.map +1 -0
  590. package/resources/messaging/email-domains.d.mts +2 -0
  591. package/resources/messaging/email-domains.d.mts.map +1 -0
  592. package/resources/messaging/email-domains.d.ts +2 -0
  593. package/resources/messaging/email-domains.d.ts.map +1 -0
  594. package/resources/messaging/email-domains.js +6 -0
  595. package/resources/messaging/email-domains.js.map +1 -0
  596. package/resources/messaging/email-domains.mjs +3 -0
  597. package/resources/messaging/email-domains.mjs.map +1 -0
  598. package/resources/messaging/email-inboxes.d.mts +327 -0
  599. package/resources/messaging/email-inboxes.d.mts.map +1 -0
  600. package/resources/messaging/email-inboxes.d.ts +327 -0
  601. package/resources/messaging/email-inboxes.d.ts.map +1 -0
  602. package/resources/messaging/email-inboxes.js +101 -0
  603. package/resources/messaging/email-inboxes.js.map +1 -0
  604. package/resources/messaging/email-inboxes.mjs +97 -0
  605. package/resources/messaging/email-inboxes.mjs.map +1 -0
  606. package/resources/messaging/groups/groups.d.mts +159 -0
  607. package/resources/messaging/groups/groups.d.mts.map +1 -0
  608. package/resources/messaging/groups/groups.d.ts +159 -0
  609. package/resources/messaging/groups/groups.d.ts.map +1 -0
  610. package/resources/messaging/groups/groups.js +107 -0
  611. package/resources/messaging/groups/groups.js.map +1 -0
  612. package/resources/messaging/groups/groups.mjs +102 -0
  613. package/resources/messaging/groups/groups.mjs.map +1 -0
  614. package/resources/messaging/groups/index.d.mts +3 -0
  615. package/resources/messaging/groups/index.d.mts.map +1 -0
  616. package/resources/messaging/groups/index.d.ts +3 -0
  617. package/resources/messaging/groups/index.d.ts.map +1 -0
  618. package/resources/messaging/groups/index.js +9 -0
  619. package/resources/messaging/groups/index.js.map +1 -0
  620. package/resources/messaging/groups/index.mjs +4 -0
  621. package/resources/messaging/groups/index.mjs.map +1 -0
  622. package/resources/messaging/groups/members.d.mts +83 -0
  623. package/resources/messaging/groups/members.d.mts.map +1 -0
  624. package/resources/messaging/groups/members.d.ts +83 -0
  625. package/resources/messaging/groups/members.d.ts.map +1 -0
  626. package/resources/messaging/groups/members.js +51 -0
  627. package/resources/messaging/groups/members.js.map +1 -0
  628. package/resources/messaging/groups/members.mjs +47 -0
  629. package/resources/messaging/groups/members.mjs.map +1 -0
  630. package/resources/messaging/groups.d.mts +2 -0
  631. package/resources/messaging/groups.d.mts.map +1 -0
  632. package/resources/messaging/groups.d.ts +2 -0
  633. package/resources/messaging/groups.d.ts.map +1 -0
  634. package/resources/messaging/groups.js +6 -0
  635. package/resources/messaging/groups.js.map +1 -0
  636. package/resources/messaging/groups.mjs +3 -0
  637. package/resources/messaging/groups.mjs.map +1 -0
  638. package/resources/messaging/index.d.mts +11 -0
  639. package/resources/messaging/index.d.mts.map +1 -0
  640. package/resources/messaging/index.d.ts +11 -0
  641. package/resources/messaging/index.d.ts.map +1 -0
  642. package/resources/messaging/index.js +25 -0
  643. package/resources/messaging/index.js.map +1 -0
  644. package/resources/messaging/index.mjs +12 -0
  645. package/resources/messaging/index.mjs.map +1 -0
  646. package/resources/messaging/messages/actions.d.mts +95 -0
  647. package/resources/messaging/messages/actions.d.mts.map +1 -0
  648. package/resources/messaging/messages/actions.d.ts +95 -0
  649. package/resources/messaging/messages/actions.d.ts.map +1 -0
  650. package/resources/messaging/messages/actions.js +79 -0
  651. package/resources/messaging/messages/actions.js.map +1 -0
  652. package/resources/messaging/messages/actions.mjs +75 -0
  653. package/resources/messaging/messages/actions.mjs.map +1 -0
  654. package/resources/messaging/messages/index.d.mts +3 -0
  655. package/resources/messaging/messages/index.d.mts.map +1 -0
  656. package/resources/messaging/messages/index.d.ts +3 -0
  657. package/resources/messaging/messages/index.d.ts.map +1 -0
  658. package/resources/messaging/messages/index.js +9 -0
  659. package/resources/messaging/messages/index.js.map +1 -0
  660. package/resources/messaging/messages/index.mjs +4 -0
  661. package/resources/messaging/messages/index.mjs.map +1 -0
  662. package/resources/messaging/messages/messages.d.mts +61 -0
  663. package/resources/messaging/messages/messages.d.mts.map +1 -0
  664. package/resources/messaging/messages/messages.d.ts +61 -0
  665. package/resources/messaging/messages/messages.d.ts.map +1 -0
  666. package/resources/messaging/messages/messages.js +40 -0
  667. package/resources/messaging/messages/messages.js.map +1 -0
  668. package/resources/messaging/messages/messages.mjs +35 -0
  669. package/resources/messaging/messages/messages.mjs.map +1 -0
  670. package/resources/messaging/messages.d.mts +2 -0
  671. package/resources/messaging/messages.d.mts.map +1 -0
  672. package/resources/messaging/messages.d.ts +2 -0
  673. package/resources/messaging/messages.d.ts.map +1 -0
  674. package/resources/messaging/messages.js +6 -0
  675. package/resources/messaging/messages.js.map +1 -0
  676. package/resources/messaging/messages.mjs +3 -0
  677. package/resources/messaging/messages.mjs.map +1 -0
  678. package/resources/messaging/messaging.d.mts +103 -0
  679. package/resources/messaging/messaging.d.mts.map +1 -0
  680. package/resources/messaging/messaging.d.ts +103 -0
  681. package/resources/messaging/messaging.d.ts.map +1 -0
  682. package/resources/messaging/messaging.js +65 -0
  683. package/resources/messaging/messaging.js.map +1 -0
  684. package/resources/messaging/messaging.mjs +60 -0
  685. package/resources/messaging/messaging.mjs.map +1 -0
  686. package/resources/messaging/notifications/actions.d.mts +92 -0
  687. package/resources/messaging/notifications/actions.d.mts.map +1 -0
  688. package/resources/messaging/notifications/actions.d.ts +92 -0
  689. package/resources/messaging/notifications/actions.d.ts.map +1 -0
  690. package/resources/messaging/notifications/actions.js +89 -0
  691. package/resources/messaging/notifications/actions.js.map +1 -0
  692. package/resources/messaging/notifications/actions.mjs +85 -0
  693. package/resources/messaging/notifications/actions.mjs.map +1 -0
  694. package/resources/messaging/notifications/index.d.mts +3 -0
  695. package/resources/messaging/notifications/index.d.mts.map +1 -0
  696. package/resources/messaging/notifications/index.d.ts +3 -0
  697. package/resources/messaging/notifications/index.d.ts.map +1 -0
  698. package/resources/messaging/notifications/index.js +9 -0
  699. package/resources/messaging/notifications/index.js.map +1 -0
  700. package/resources/messaging/notifications/index.mjs +4 -0
  701. package/resources/messaging/notifications/index.mjs.map +1 -0
  702. package/resources/messaging/notifications/notifications.d.mts +440 -0
  703. package/resources/messaging/notifications/notifications.d.mts.map +1 -0
  704. package/resources/messaging/notifications/notifications.d.ts +440 -0
  705. package/resources/messaging/notifications/notifications.d.ts.map +1 -0
  706. package/resources/messaging/notifications/notifications.js +104 -0
  707. package/resources/messaging/notifications/notifications.js.map +1 -0
  708. package/resources/messaging/notifications/notifications.mjs +99 -0
  709. package/resources/messaging/notifications/notifications.mjs.map +1 -0
  710. package/resources/messaging/notifications.d.mts +2 -0
  711. package/resources/messaging/notifications.d.mts.map +1 -0
  712. package/resources/messaging/notifications.d.ts +2 -0
  713. package/resources/messaging/notifications.d.ts.map +1 -0
  714. package/resources/messaging/notifications.js +6 -0
  715. package/resources/messaging/notifications.js.map +1 -0
  716. package/resources/messaging/notifications.mjs +3 -0
  717. package/resources/messaging/notifications.mjs.map +1 -0
  718. package/resources/messaging/preferences.d.mts +180 -0
  719. package/resources/messaging/preferences.d.mts.map +1 -0
  720. package/resources/messaging/preferences.d.ts +180 -0
  721. package/resources/messaging/preferences.d.ts.map +1 -0
  722. package/resources/messaging/preferences.js +47 -0
  723. package/resources/messaging/preferences.js.map +1 -0
  724. package/resources/messaging/preferences.mjs +43 -0
  725. package/resources/messaging/preferences.mjs.map +1 -0
  726. package/resources/messaging.d.mts +2 -0
  727. package/resources/messaging.d.mts.map +1 -0
  728. package/resources/messaging.d.ts +2 -0
  729. package/resources/messaging.d.ts.map +1 -0
  730. package/resources/messaging.js +6 -0
  731. package/resources/messaging.js.map +1 -0
  732. package/resources/messaging.mjs +3 -0
  733. package/resources/messaging.mjs.map +1 -0
  734. package/resources/operations/carriers/carriers.d.mts +102 -63
  735. package/resources/operations/carriers/carriers.d.mts.map +1 -1
  736. package/resources/operations/carriers/carriers.d.ts +102 -63
  737. package/resources/operations/carriers/carriers.d.ts.map +1 -1
  738. package/resources/operations/carriers/carriers.js +41 -21
  739. package/resources/operations/carriers/carriers.js.map +1 -1
  740. package/resources/operations/carriers/carriers.mjs +41 -21
  741. package/resources/operations/carriers/carriers.mjs.map +1 -1
  742. package/resources/operations/carriers/index.d.mts +2 -2
  743. package/resources/operations/carriers/index.d.mts.map +1 -1
  744. package/resources/operations/carriers/index.d.ts +2 -2
  745. package/resources/operations/carriers/index.d.ts.map +1 -1
  746. package/resources/operations/carriers/index.mjs.map +1 -1
  747. package/resources/operations/carriers/service-levels.d.mts +127 -68
  748. package/resources/operations/carriers/service-levels.d.mts.map +1 -1
  749. package/resources/operations/carriers/service-levels.d.ts +127 -68
  750. package/resources/operations/carriers/service-levels.d.ts.map +1 -1
  751. package/resources/operations/carriers/service-levels.js +49 -30
  752. package/resources/operations/carriers/service-levels.js.map +1 -1
  753. package/resources/operations/carriers/service-levels.mjs +49 -30
  754. package/resources/operations/carriers/service-levels.mjs.map +1 -1
  755. package/resources/operations/carriers.d.mts.map +1 -1
  756. package/resources/operations/carriers.d.ts.map +1 -1
  757. package/resources/operations/carriers.mjs.map +1 -1
  758. package/resources/operations/index.d.mts +4 -4
  759. package/resources/operations/index.d.mts.map +1 -1
  760. package/resources/operations/index.d.ts +4 -4
  761. package/resources/operations/index.d.ts.map +1 -1
  762. package/resources/operations/index.mjs.map +1 -1
  763. package/resources/operations/location-types.d.mts +37 -18
  764. package/resources/operations/location-types.d.mts.map +1 -1
  765. package/resources/operations/location-types.d.ts +37 -18
  766. package/resources/operations/location-types.d.ts.map +1 -1
  767. package/resources/operations/location-types.js +16 -12
  768. package/resources/operations/location-types.js.map +1 -1
  769. package/resources/operations/location-types.mjs +16 -12
  770. package/resources/operations/location-types.mjs.map +1 -1
  771. package/resources/operations/locations.d.mts +142 -66
  772. package/resources/operations/locations.d.mts.map +1 -1
  773. package/resources/operations/locations.d.ts +142 -66
  774. package/resources/operations/locations.d.ts.map +1 -1
  775. package/resources/operations/locations.js +34 -20
  776. package/resources/operations/locations.js.map +1 -1
  777. package/resources/operations/locations.mjs +34 -20
  778. package/resources/operations/locations.mjs.map +1 -1
  779. package/resources/operations/operations.d.mts +4 -4
  780. package/resources/operations/operations.d.mts.map +1 -1
  781. package/resources/operations/operations.d.ts +4 -4
  782. package/resources/operations/operations.d.ts.map +1 -1
  783. package/resources/operations/operations.mjs.map +1 -1
  784. package/resources/operations/scanning-stations.d.mts +155 -71
  785. package/resources/operations/scanning-stations.d.mts.map +1 -1
  786. package/resources/operations/scanning-stations.d.ts +155 -71
  787. package/resources/operations/scanning-stations.d.ts.map +1 -1
  788. package/resources/operations/scanning-stations.js +42 -23
  789. package/resources/operations/scanning-stations.js.map +1 -1
  790. package/resources/operations/scanning-stations.mjs +42 -23
  791. package/resources/operations/scanning-stations.mjs.map +1 -1
  792. package/resources/operations/shipping-terms.d.mts +127 -81
  793. package/resources/operations/shipping-terms.d.mts.map +1 -1
  794. package/resources/operations/shipping-terms.d.ts +127 -81
  795. package/resources/operations/shipping-terms.d.ts.map +1 -1
  796. package/resources/operations/shipping-terms.js +38 -26
  797. package/resources/operations/shipping-terms.js.map +1 -1
  798. package/resources/operations/shipping-terms.mjs +38 -26
  799. package/resources/operations/shipping-terms.mjs.map +1 -1
  800. package/resources/operations.d.mts.map +1 -1
  801. package/resources/operations.d.ts.map +1 -1
  802. package/resources/operations.mjs.map +1 -1
  803. package/resources/sales/account-groups.d.mts +121 -80
  804. package/resources/sales/account-groups.d.mts.map +1 -1
  805. package/resources/sales/account-groups.d.ts +121 -80
  806. package/resources/sales/account-groups.d.ts.map +1 -1
  807. package/resources/sales/account-groups.js +40 -21
  808. package/resources/sales/account-groups.js.map +1 -1
  809. package/resources/sales/account-groups.mjs +40 -21
  810. package/resources/sales/account-groups.mjs.map +1 -1
  811. package/resources/sales/account-statuses.d.mts +42 -24
  812. package/resources/sales/account-statuses.d.mts.map +1 -1
  813. package/resources/sales/account-statuses.d.ts +42 -24
  814. package/resources/sales/account-statuses.d.ts.map +1 -1
  815. package/resources/sales/account-statuses.js +16 -13
  816. package/resources/sales/account-statuses.js.map +1 -1
  817. package/resources/sales/account-statuses.mjs +16 -13
  818. package/resources/sales/account-statuses.mjs.map +1 -1
  819. package/resources/sales/addresses.d.mts +102 -40
  820. package/resources/sales/addresses.d.mts.map +1 -1
  821. package/resources/sales/addresses.d.ts +102 -40
  822. package/resources/sales/addresses.d.ts.map +1 -1
  823. package/resources/sales/addresses.js +44 -19
  824. package/resources/sales/addresses.js.map +1 -1
  825. package/resources/sales/addresses.mjs +44 -19
  826. package/resources/sales/addresses.mjs.map +1 -1
  827. package/resources/sales/contacts/actions.d.mts +120 -0
  828. package/resources/sales/contacts/actions.d.mts.map +1 -0
  829. package/resources/sales/contacts/actions.d.ts +120 -0
  830. package/resources/sales/contacts/actions.d.ts.map +1 -0
  831. package/resources/sales/contacts/actions.js +38 -0
  832. package/resources/sales/contacts/actions.js.map +1 -0
  833. package/resources/sales/contacts/actions.mjs +34 -0
  834. package/resources/sales/contacts/actions.mjs.map +1 -0
  835. package/resources/sales/contacts/contacts.d.mts +10 -0
  836. package/resources/sales/contacts/contacts.d.mts.map +1 -0
  837. package/resources/sales/contacts/contacts.d.ts +10 -0
  838. package/resources/sales/contacts/contacts.d.ts.map +1 -0
  839. package/resources/sales/contacts/contacts.js +17 -0
  840. package/resources/sales/contacts/contacts.js.map +1 -0
  841. package/resources/sales/contacts/contacts.mjs +12 -0
  842. package/resources/sales/contacts/contacts.mjs.map +1 -0
  843. package/resources/sales/contacts/index.d.mts +3 -0
  844. package/resources/sales/contacts/index.d.mts.map +1 -0
  845. package/resources/sales/contacts/index.d.ts +3 -0
  846. package/resources/sales/contacts/index.d.ts.map +1 -0
  847. package/resources/sales/contacts/index.js +9 -0
  848. package/resources/sales/contacts/index.js.map +1 -0
  849. package/resources/sales/contacts/index.mjs +4 -0
  850. package/resources/sales/contacts/index.mjs.map +1 -0
  851. package/resources/sales/contacts.d.mts +2 -0
  852. package/resources/sales/contacts.d.mts.map +1 -0
  853. package/resources/sales/contacts.d.ts +2 -0
  854. package/resources/sales/contacts.d.ts.map +1 -0
  855. package/resources/sales/contacts.js +6 -0
  856. package/resources/sales/contacts.js.map +1 -0
  857. package/resources/sales/contacts.mjs +3 -0
  858. package/resources/sales/contacts.mjs.map +1 -0
  859. package/resources/sales/customers/actions.d.mts +17 -5
  860. package/resources/sales/customers/actions.d.mts.map +1 -1
  861. package/resources/sales/customers/actions.d.ts +17 -5
  862. package/resources/sales/customers/actions.d.ts.map +1 -1
  863. package/resources/sales/customers/actions.js +8 -2
  864. package/resources/sales/customers/actions.js.map +1 -1
  865. package/resources/sales/customers/actions.mjs +8 -2
  866. package/resources/sales/customers/actions.mjs.map +1 -1
  867. package/resources/sales/customers/customers.d.mts +483 -722
  868. package/resources/sales/customers/customers.d.mts.map +1 -1
  869. package/resources/sales/customers/customers.d.ts +483 -722
  870. package/resources/sales/customers/customers.d.ts.map +1 -1
  871. package/resources/sales/customers/customers.js +68 -30
  872. package/resources/sales/customers/customers.js.map +1 -1
  873. package/resources/sales/customers/customers.mjs +68 -30
  874. package/resources/sales/customers/customers.mjs.map +1 -1
  875. package/resources/sales/customers/index.d.mts +1 -1
  876. package/resources/sales/customers/index.d.mts.map +1 -1
  877. package/resources/sales/customers/index.d.ts +1 -1
  878. package/resources/sales/customers/index.d.ts.map +1 -1
  879. package/resources/sales/customers/index.js.map +1 -1
  880. package/resources/sales/customers/index.mjs.map +1 -1
  881. package/resources/sales/customers.d.mts.map +1 -1
  882. package/resources/sales/customers.d.ts.map +1 -1
  883. package/resources/sales/customers.mjs.map +1 -1
  884. package/resources/sales/index.d.mts +7 -6
  885. package/resources/sales/index.d.mts.map +1 -1
  886. package/resources/sales/index.d.ts +7 -6
  887. package/resources/sales/index.d.ts.map +1 -1
  888. package/resources/sales/index.js +5 -3
  889. package/resources/sales/index.js.map +1 -1
  890. package/resources/sales/index.mjs +1 -0
  891. package/resources/sales/index.mjs.map +1 -1
  892. package/resources/sales/priorities.d.mts +36 -22
  893. package/resources/sales/priorities.d.mts.map +1 -1
  894. package/resources/sales/priorities.d.ts +36 -22
  895. package/resources/sales/priorities.d.ts.map +1 -1
  896. package/resources/sales/priorities.js +14 -10
  897. package/resources/sales/priorities.js.map +1 -1
  898. package/resources/sales/priorities.mjs +14 -10
  899. package/resources/sales/priorities.mjs.map +1 -1
  900. package/resources/sales/sales-orders.d.mts +882 -9
  901. package/resources/sales/sales-orders.d.mts.map +1 -1
  902. package/resources/sales/sales-orders.d.ts +882 -9
  903. package/resources/sales/sales-orders.d.ts.map +1 -1
  904. package/resources/sales/sales-orders.js +50 -3
  905. package/resources/sales/sales-orders.js.map +1 -1
  906. package/resources/sales/sales-orders.mjs +50 -3
  907. package/resources/sales/sales-orders.mjs.map +1 -1
  908. package/resources/sales/sales.d.mts +12 -8
  909. package/resources/sales/sales.d.mts.map +1 -1
  910. package/resources/sales/sales.d.ts +12 -8
  911. package/resources/sales/sales.d.ts.map +1 -1
  912. package/resources/sales/sales.js +4 -0
  913. package/resources/sales/sales.js.map +1 -1
  914. package/resources/sales/sales.mjs +4 -0
  915. package/resources/sales/sales.mjs.map +1 -1
  916. package/resources/sales.d.mts.map +1 -1
  917. package/resources/sales.d.ts.map +1 -1
  918. package/resources/sales.mjs.map +1 -1
  919. package/resources/settings/index.d.mts +3 -0
  920. package/resources/settings/index.d.mts.map +1 -0
  921. package/resources/settings/index.d.ts +3 -0
  922. package/resources/settings/index.d.ts.map +1 -0
  923. package/resources/settings/index.js +9 -0
  924. package/resources/settings/index.js.map +1 -0
  925. package/resources/settings/index.mjs +4 -0
  926. package/resources/settings/index.mjs.map +1 -0
  927. package/resources/settings/integrations.d.mts +246 -0
  928. package/resources/settings/integrations.d.mts.map +1 -0
  929. package/resources/settings/integrations.d.ts +246 -0
  930. package/resources/settings/integrations.d.ts.map +1 -0
  931. package/resources/settings/integrations.js +88 -0
  932. package/resources/settings/integrations.js.map +1 -0
  933. package/resources/settings/integrations.mjs +84 -0
  934. package/resources/settings/integrations.mjs.map +1 -0
  935. package/resources/settings/settings.d.mts +10 -0
  936. package/resources/settings/settings.d.mts.map +1 -0
  937. package/resources/settings/settings.d.ts +10 -0
  938. package/resources/settings/settings.d.ts.map +1 -0
  939. package/resources/settings/settings.js +17 -0
  940. package/resources/settings/settings.js.map +1 -0
  941. package/resources/settings/settings.mjs +12 -0
  942. package/resources/settings/settings.mjs.map +1 -0
  943. package/resources/settings.d.mts +2 -0
  944. package/resources/settings.d.mts.map +1 -0
  945. package/resources/settings.d.ts +2 -0
  946. package/resources/settings.d.ts.map +1 -0
  947. package/resources/settings.js +6 -0
  948. package/resources/settings.js.map +1 -0
  949. package/resources/settings.mjs +3 -0
  950. package/resources/settings.mjs.map +1 -0
  951. package/resources.d.mts.map +1 -1
  952. package/resources.d.ts.map +1 -1
  953. package/resources.mjs.map +1 -1
  954. package/src/client.ts +35 -5
  955. package/src/resources/auth/api-keys/actions.ts +30 -5
  956. package/src/resources/auth/api-keys/api-keys.ts +152 -80
  957. package/src/resources/auth/api-keys/index.ts +1 -1
  958. package/src/resources/auth/auth.ts +1 -1
  959. package/src/resources/auth/index.ts +1 -1
  960. package/src/resources/catalog/catalog.ts +18 -18
  961. package/src/resources/catalog/index.ts +18 -18
  962. package/src/resources/catalog/item-categories/index.ts +2 -2
  963. package/src/resources/catalog/item-categories/item-categories.ts +128 -86
  964. package/src/resources/catalog/item-categories/properties.ts +13 -4
  965. package/src/resources/catalog/items/attributes.ts +7 -2
  966. package/src/resources/catalog/items/index.ts +2 -2
  967. package/src/resources/catalog/items/items.ts +119 -75
  968. package/src/resources/catalog/materials.ts +181 -119
  969. package/src/resources/catalog/parts.ts +160 -92
  970. package/src/resources/catalog/product-lines.ts +172 -85
  971. package/src/resources/catalog/products.ts +223 -112
  972. package/src/resources/catalog/properties/attributes.ts +120 -58
  973. package/src/resources/catalog/properties/index.ts +4 -4
  974. package/src/resources/catalog/properties/properties.ts +94 -61
  975. package/src/resources/catalog/unit-groups/index.ts +4 -4
  976. package/src/resources/catalog/unit-groups/unit-groups.ts +157 -99
  977. package/src/resources/catalog/unit-groups/units.ts +107 -73
  978. package/src/resources/catalog/units.ts +158 -98
  979. package/src/resources/core/addresses/actions.ts +12 -5
  980. package/src/resources/core/addresses/addresses.ts +5 -2
  981. package/src/resources/core/audit-events.ts +251 -56
  982. package/src/resources/core/core.ts +605 -5
  983. package/src/resources/core/email-logs.ts +45 -30
  984. package/src/resources/core/index.ts +6 -6
  985. package/src/resources/core/request-logs.ts +125 -70
  986. package/src/resources/core/sandboxes.ts +67 -38
  987. package/src/resources/finance/finance.ts +78 -44
  988. package/src/resources/finance/index.ts +4 -4
  989. package/src/resources/finance/payment-terms.ts +95 -56
  990. package/src/resources/identity/account-users/account-users.ts +196 -97
  991. package/src/resources/identity/account-users/actions.ts +22 -3
  992. package/src/resources/identity/account-users/index.ts +2 -2
  993. package/src/resources/identity/identity.ts +4 -4
  994. package/src/resources/identity/index.ts +4 -4
  995. package/src/resources/identity/roles.ts +113 -70
  996. package/src/resources/index.ts +5 -3
  997. package/src/resources/messaging/announcements/actions.ts +119 -0
  998. package/src/resources/messaging/announcements/announcements.ts +234 -0
  999. package/src/resources/messaging/announcements/index.ts +10 -0
  1000. package/src/resources/messaging/announcements.ts +3 -0
  1001. package/src/resources/messaging/blocks.ts +826 -0
  1002. package/src/resources/messaging/conversations/actions.ts +766 -0
  1003. package/src/resources/messaging/conversations/attachments/actions.ts +116 -0
  1004. package/src/resources/messaging/conversations/attachments/attachments.ts +25 -0
  1005. package/src/resources/messaging/conversations/attachments/index.ts +9 -0
  1006. package/src/resources/messaging/conversations/attachments.ts +3 -0
  1007. package/src/resources/messaging/conversations/conversations.ts +2452 -0
  1008. package/src/resources/messaging/conversations/index.ts +80 -0
  1009. package/src/resources/messaging/conversations/links.ts +690 -0
  1010. package/src/resources/messaging/conversations/messages.ts +906 -0
  1011. package/src/resources/messaging/conversations/participants/actions.ts +92 -0
  1012. package/src/resources/messaging/conversations/participants/index.ts +10 -0
  1013. package/src/resources/messaging/conversations/participants/participants.ts +150 -0
  1014. package/src/resources/messaging/conversations/participants.ts +3 -0
  1015. package/src/resources/messaging/conversations.ts +3 -0
  1016. package/src/resources/messaging/email-domains/actions.ts +32 -0
  1017. package/src/resources/messaging/email-domains/email-domains.ts +170 -0
  1018. package/src/resources/messaging/email-domains/index.ts +10 -0
  1019. package/src/resources/messaging/email-domains.ts +3 -0
  1020. package/src/resources/messaging/email-inboxes.ts +408 -0
  1021. package/src/resources/messaging/groups/groups.ts +208 -0
  1022. package/src/resources/messaging/groups/index.ts +17 -0
  1023. package/src/resources/messaging/groups/members.ts +112 -0
  1024. package/src/resources/messaging/groups.ts +3 -0
  1025. package/src/resources/messaging/index.ts +115 -0
  1026. package/src/resources/messaging/messages/actions.ts +184 -0
  1027. package/src/resources/messaging/messages/index.ts +10 -0
  1028. package/src/resources/messaging/messages/messages.ts +107 -0
  1029. package/src/resources/messaging/messages.ts +3 -0
  1030. package/src/resources/messaging/messaging.ts +351 -0
  1031. package/src/resources/messaging/notifications/actions.ts +139 -0
  1032. package/src/resources/messaging/notifications/index.ts +24 -0
  1033. package/src/resources/messaging/notifications/notifications.ts +1051 -0
  1034. package/src/resources/messaging/notifications.ts +3 -0
  1035. package/src/resources/messaging/preferences.ts +215 -0
  1036. package/src/resources/messaging.ts +3 -0
  1037. package/src/resources/operations/carriers/carriers.ts +110 -71
  1038. package/src/resources/operations/carriers/index.ts +4 -4
  1039. package/src/resources/operations/carriers/service-levels.ts +148 -89
  1040. package/src/resources/operations/index.ts +8 -8
  1041. package/src/resources/operations/location-types.ts +42 -23
  1042. package/src/resources/operations/locations.ts +153 -77
  1043. package/src/resources/operations/operations.ts +8 -8
  1044. package/src/resources/operations/scanning-stations.ts +173 -89
  1045. package/src/resources/operations/shipping-terms.ts +144 -98
  1046. package/src/resources/sales/account-groups.ts +132 -91
  1047. package/src/resources/sales/account-statuses.ts +49 -31
  1048. package/src/resources/sales/addresses.ts +110 -48
  1049. package/src/resources/sales/contacts/actions.ts +150 -0
  1050. package/src/resources/sales/contacts/contacts.ts +27 -0
  1051. package/src/resources/sales/contacts/index.ts +10 -0
  1052. package/src/resources/sales/contacts.ts +3 -0
  1053. package/src/resources/sales/customers/actions.ts +19 -4
  1054. package/src/resources/sales/customers/customers.ts +547 -884
  1055. package/src/resources/sales/customers/index.ts +2 -15
  1056. package/src/resources/sales/index.ts +24 -19
  1057. package/src/resources/sales/priorities.ts +44 -30
  1058. package/src/resources/sales/sales-orders.ts +1115 -22
  1059. package/src/resources/sales/sales.ts +46 -32
  1060. package/src/resources/settings/index.ts +13 -0
  1061. package/src/resources/settings/integrations.ts +299 -0
  1062. package/src/resources/settings/settings.ts +33 -0
  1063. package/src/resources/settings.ts +3 -0
  1064. package/src/version.ts +1 -1
  1065. package/uploads.d.mts +0 -1
  1066. package/uploads.d.mts.map +1 -1
  1067. package/uploads.d.ts +0 -1
  1068. package/uploads.d.ts.map +1 -1
  1069. package/uploads.mjs +0 -1
  1070. package/uploads.mjs.map +1 -1
  1071. package/version.d.mts +1 -1
  1072. package/version.d.ts +1 -1
  1073. package/version.js +1 -1
  1074. package/version.mjs +1 -1
@@ -7,24 +7,21 @@ import { RequestOptions } from "../../internal/request-options.mjs";
7
7
  */
8
8
  export declare class Roles extends APIResource {
9
9
  /**
10
- * Creates a new role with the specified permissions.
10
+ * Returns a paginated list of roles for the target account, including global
11
+ * roles.
12
+ *
13
+ * This endpoint requires the permission: `roles:read`.
11
14
  *
12
15
  * @example
13
16
  * ```ts
14
- * const role = await client.identity.roles.create({
15
- * name: 'Warehouse Manager',
16
- * permissions: [
17
- * 'customers:create',
18
- * 'customers:read',
19
- * 'customers:update',
20
- * 'invoices:read',
21
- * ],
22
- * });
17
+ * const listRole = await client.identity.roles.list();
23
18
  * ```
24
19
  */
25
- create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
20
+ list(query?: RoleListParams | null | undefined, options?: RequestOptions): APIPromise<ListRole>;
26
21
  /**
27
- * Returns a role by ID, including its structured permissions.
22
+ * Returns a role by ID, including its permissions.
23
+ *
24
+ * This endpoint requires the permission: `roles:read`.
28
25
  *
29
26
  * @example
30
27
  * ```ts
@@ -35,29 +32,52 @@ export declare class Roles extends APIResource {
35
32
  */
36
33
  retrieve(id: string, query?: RoleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
37
34
  /**
38
- * Partially updates a custom role's name or permissions. Provided permissions
39
- * replace all existing ones; global roles cannot be modified.
35
+ * Creates a custom role with the specified permissions.
36
+ *
37
+ * Roles created through the API always have type `user`.
38
+ *
39
+ * This endpoint requires the permission: `roles:create`.
40
40
  *
41
41
  * @example
42
42
  * ```ts
43
- * const role = await client.identity.roles.update(
44
- * 'rl_01c16d2eb637c0d1f3a372937c',
45
- * );
43
+ * const role = await client.identity.roles.create({
44
+ * name: 'Warehouse Manager',
45
+ * permissions: [
46
+ * 'customers:create',
47
+ * 'customers:read',
48
+ * 'customers:update',
49
+ * 'invoices:read',
50
+ * ],
51
+ * });
46
52
  * ```
47
53
  */
48
- update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
54
+ create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
49
55
  /**
50
- * Returns a paginated list of roles for the target account, including global
51
- * roles.
56
+ * Partially updates a custom role's name or permissions.
57
+ *
58
+ * Provided permissions replace all existing ones; global roles cannot be modified.
59
+ *
60
+ * This endpoint requires the permission: `roles:update`.
52
61
  *
53
62
  * @example
54
63
  * ```ts
55
- * const listRole = await client.identity.roles.list();
64
+ * const role = await client.identity.roles.update(
65
+ * 'rl_01c16d2eb637c0d1f3a372937c',
66
+ * {
67
+ * name: 'Updated Manager',
68
+ * permissions: ['customers:read', 'customers:update'],
69
+ * },
70
+ * );
56
71
  * ```
57
72
  */
58
- list(query?: RoleListParams | null | undefined, options?: RequestOptions): APIPromise<ListRole>;
73
+ update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
59
74
  /**
60
- * Deletes a role and its associated permissions. Global roles cannot be deleted.
75
+ * Deletes a role and its associated permissions.
76
+ *
77
+ * Global roles and roles currently assigned to one or more users cannot be
78
+ * deleted.
79
+ *
80
+ * This endpoint requires the permission: `roles:delete`.
61
81
  *
62
82
  * @example
63
83
  * ```ts
@@ -73,13 +93,16 @@ export declare class Roles extends APIResource {
73
93
  */
74
94
  export interface CreateRoleRequest {
75
95
  /**
76
- * Display name.
96
+ * Display name for the role, unique within the account.
77
97
  */
78
98
  name: string;
79
99
  /**
80
- * Permissions to attach in `<domain>:<action>` format.
100
+ * Permissions to grant, in `{domain}:{action}` format, such as `customers:read`.
101
+ *
102
+ * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
103
+ * create a role with no permissions.
81
104
  */
82
- permissions: Array<string>;
105
+ permissions?: Array<string>;
83
106
  }
84
107
  /**
85
108
  * List represents a paginated list of resources.
@@ -103,31 +126,50 @@ export interface ListRole {
103
126
  */
104
127
  export interface UpdateRoleRequest {
105
128
  /**
106
- * Display name.
129
+ * New display name for the role, unique within the account.
130
+ *
131
+ * Omit to leave unchanged.
107
132
  */
108
133
  name?: string;
109
134
  /**
110
- * Permissions in `<domain>:<action>` format. Replaces all existing permissions;
111
- * omit to leave unchanged.
135
+ * Full replacement set of permissions, in `{domain}:{action}` format, such as
136
+ * `customers:read`.
137
+ *
138
+ * Replaces all existing permissions on the role. Pass an empty array to remove all
139
+ * permissions, or omit to leave them unchanged.
112
140
  */
113
141
  permissions?: Array<string>;
114
142
  }
115
143
  export interface RoleDeleteResponse {
116
144
  }
117
- export interface RoleCreateParams {
145
+ export interface RoleListParams {
118
146
  /**
119
- * Body param: Display name.
147
+ * Opaque cursor token identifying where the page of results starts.
148
+ *
149
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
150
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
151
+ * page.
120
152
  */
121
- name: string;
153
+ cursor?: string;
122
154
  /**
123
- * Body param: Permissions to attach in `<domain>:<action>` format.
155
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
156
+ * `null`.
124
157
  */
125
- permissions: Array<string>;
158
+ include?: Array<'owner' | 'owner.account' | 'permissions'>;
126
159
  /**
127
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
128
- * are returned as `null`.
160
+ * Maximum number of results to return in a single page.
129
161
  */
130
- include?: Array<'owner' | 'owner.account' | 'permissions'>;
162
+ limit?: number;
163
+ /**
164
+ * Free-text search term used to filter results.
165
+ *
166
+ * Which fields are matched against the term varies by endpoint.
167
+ */
168
+ q?: string;
169
+ /**
170
+ * Filter results to roles whose type matches any of the given values.
171
+ */
172
+ types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
131
173
  }
132
174
  export interface RoleRetrieveParams {
133
175
  /**
@@ -136,46 +178,47 @@ export interface RoleRetrieveParams {
136
178
  */
137
179
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
138
180
  }
139
- export interface RoleUpdateParams {
181
+ export interface RoleCreateParams {
182
+ /**
183
+ * Body param: Display name for the role, unique within the account.
184
+ */
185
+ name: string;
140
186
  /**
141
187
  * Query param: Sub-objects to expand in the response. When omitted, sub-objects
142
188
  * are returned as `null`.
143
189
  */
144
190
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
145
191
  /**
146
- * Body param: Display name.
147
- */
148
- name?: string;
149
- /**
150
- * Body param: Permissions in `<domain>:<action>` format. Replaces all existing
151
- * permissions; omit to leave unchanged.
192
+ * Body param: Permissions to grant, in `{domain}:{action}` format, such as
193
+ * `customers:read`.
194
+ *
195
+ * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
196
+ * create a role with no permissions.
152
197
  */
153
198
  permissions?: Array<string>;
154
199
  }
155
- export interface RoleListParams {
156
- /**
157
- * Cursor token used to retrieve the next or previous page of results.
158
- */
159
- cursor?: string;
200
+ export interface RoleUpdateParams {
160
201
  /**
161
- * Sub-objects to expand in the response. When omitted, sub-objects are returned as
162
- * `null`.
202
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
203
+ * are returned as `null`.
163
204
  */
164
205
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
165
206
  /**
166
- * Maximum number of results per page (default: 100, max: 1000).
167
- */
168
- limit?: number;
169
- /**
170
- * Search query used to filter results.
207
+ * Body param: New display name for the role, unique within the account.
208
+ *
209
+ * Omit to leave unchanged.
171
210
  */
172
- q?: string;
211
+ name?: string;
173
212
  /**
174
- * Filter by role types.
213
+ * Body param: Full replacement set of permissions, in `{domain}:{action}` format,
214
+ * such as `customers:read`.
215
+ *
216
+ * Replaces all existing permissions on the role. Pass an empty array to remove all
217
+ * permissions, or omit to leave them unchanged.
175
218
  */
176
- types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
219
+ permissions?: Array<string>;
177
220
  }
178
221
  export declare namespace Roles {
179
- export { type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleUpdateParams as RoleUpdateParams, type RoleListParams as RoleListParams, };
222
+ export { type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleListParams as RoleListParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleCreateParams as RoleCreateParams, type RoleUpdateParams as RoleUpdateParams, };
180
223
  }
181
224
  //# sourceMappingURL=roles.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"roles.d.mts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,sCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
1
+ {"version":3,"file":"roles.d.mts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -7,24 +7,21 @@ import { RequestOptions } from "../../internal/request-options.js";
7
7
  */
8
8
  export declare class Roles extends APIResource {
9
9
  /**
10
- * Creates a new role with the specified permissions.
10
+ * Returns a paginated list of roles for the target account, including global
11
+ * roles.
12
+ *
13
+ * This endpoint requires the permission: `roles:read`.
11
14
  *
12
15
  * @example
13
16
  * ```ts
14
- * const role = await client.identity.roles.create({
15
- * name: 'Warehouse Manager',
16
- * permissions: [
17
- * 'customers:create',
18
- * 'customers:read',
19
- * 'customers:update',
20
- * 'invoices:read',
21
- * ],
22
- * });
17
+ * const listRole = await client.identity.roles.list();
23
18
  * ```
24
19
  */
25
- create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
20
+ list(query?: RoleListParams | null | undefined, options?: RequestOptions): APIPromise<ListRole>;
26
21
  /**
27
- * Returns a role by ID, including its structured permissions.
22
+ * Returns a role by ID, including its permissions.
23
+ *
24
+ * This endpoint requires the permission: `roles:read`.
28
25
  *
29
26
  * @example
30
27
  * ```ts
@@ -35,29 +32,52 @@ export declare class Roles extends APIResource {
35
32
  */
36
33
  retrieve(id: string, query?: RoleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
37
34
  /**
38
- * Partially updates a custom role's name or permissions. Provided permissions
39
- * replace all existing ones; global roles cannot be modified.
35
+ * Creates a custom role with the specified permissions.
36
+ *
37
+ * Roles created through the API always have type `user`.
38
+ *
39
+ * This endpoint requires the permission: `roles:create`.
40
40
  *
41
41
  * @example
42
42
  * ```ts
43
- * const role = await client.identity.roles.update(
44
- * 'rl_01c16d2eb637c0d1f3a372937c',
45
- * );
43
+ * const role = await client.identity.roles.create({
44
+ * name: 'Warehouse Manager',
45
+ * permissions: [
46
+ * 'customers:create',
47
+ * 'customers:read',
48
+ * 'customers:update',
49
+ * 'invoices:read',
50
+ * ],
51
+ * });
46
52
  * ```
47
53
  */
48
- update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
54
+ create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
49
55
  /**
50
- * Returns a paginated list of roles for the target account, including global
51
- * roles.
56
+ * Partially updates a custom role's name or permissions.
57
+ *
58
+ * Provided permissions replace all existing ones; global roles cannot be modified.
59
+ *
60
+ * This endpoint requires the permission: `roles:update`.
52
61
  *
53
62
  * @example
54
63
  * ```ts
55
- * const listRole = await client.identity.roles.list();
64
+ * const role = await client.identity.roles.update(
65
+ * 'rl_01c16d2eb637c0d1f3a372937c',
66
+ * {
67
+ * name: 'Updated Manager',
68
+ * permissions: ['customers:read', 'customers:update'],
69
+ * },
70
+ * );
56
71
  * ```
57
72
  */
58
- list(query?: RoleListParams | null | undefined, options?: RequestOptions): APIPromise<ListRole>;
73
+ update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
59
74
  /**
60
- * Deletes a role and its associated permissions. Global roles cannot be deleted.
75
+ * Deletes a role and its associated permissions.
76
+ *
77
+ * Global roles and roles currently assigned to one or more users cannot be
78
+ * deleted.
79
+ *
80
+ * This endpoint requires the permission: `roles:delete`.
61
81
  *
62
82
  * @example
63
83
  * ```ts
@@ -73,13 +93,16 @@ export declare class Roles extends APIResource {
73
93
  */
74
94
  export interface CreateRoleRequest {
75
95
  /**
76
- * Display name.
96
+ * Display name for the role, unique within the account.
77
97
  */
78
98
  name: string;
79
99
  /**
80
- * Permissions to attach in `<domain>:<action>` format.
100
+ * Permissions to grant, in `{domain}:{action}` format, such as `customers:read`.
101
+ *
102
+ * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
103
+ * create a role with no permissions.
81
104
  */
82
- permissions: Array<string>;
105
+ permissions?: Array<string>;
83
106
  }
84
107
  /**
85
108
  * List represents a paginated list of resources.
@@ -103,31 +126,50 @@ export interface ListRole {
103
126
  */
104
127
  export interface UpdateRoleRequest {
105
128
  /**
106
- * Display name.
129
+ * New display name for the role, unique within the account.
130
+ *
131
+ * Omit to leave unchanged.
107
132
  */
108
133
  name?: string;
109
134
  /**
110
- * Permissions in `<domain>:<action>` format. Replaces all existing permissions;
111
- * omit to leave unchanged.
135
+ * Full replacement set of permissions, in `{domain}:{action}` format, such as
136
+ * `customers:read`.
137
+ *
138
+ * Replaces all existing permissions on the role. Pass an empty array to remove all
139
+ * permissions, or omit to leave them unchanged.
112
140
  */
113
141
  permissions?: Array<string>;
114
142
  }
115
143
  export interface RoleDeleteResponse {
116
144
  }
117
- export interface RoleCreateParams {
145
+ export interface RoleListParams {
118
146
  /**
119
- * Body param: Display name.
147
+ * Opaque cursor token identifying where the page of results starts.
148
+ *
149
+ * Use the `cursor` value embedded in a previous response's `next_page_url` or
150
+ * `previous_page_url` to fetch the adjacent page. Omit to start from the first
151
+ * page.
120
152
  */
121
- name: string;
153
+ cursor?: string;
122
154
  /**
123
- * Body param: Permissions to attach in `<domain>:<action>` format.
155
+ * Sub-objects to expand in the response. When omitted, sub-objects are returned as
156
+ * `null`.
124
157
  */
125
- permissions: Array<string>;
158
+ include?: Array<'owner' | 'owner.account' | 'permissions'>;
126
159
  /**
127
- * Query param: Sub-objects to expand in the response. When omitted, sub-objects
128
- * are returned as `null`.
160
+ * Maximum number of results to return in a single page.
129
161
  */
130
- include?: Array<'owner' | 'owner.account' | 'permissions'>;
162
+ limit?: number;
163
+ /**
164
+ * Free-text search term used to filter results.
165
+ *
166
+ * Which fields are matched against the term varies by endpoint.
167
+ */
168
+ q?: string;
169
+ /**
170
+ * Filter results to roles whose type matches any of the given values.
171
+ */
172
+ types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
131
173
  }
132
174
  export interface RoleRetrieveParams {
133
175
  /**
@@ -136,46 +178,47 @@ export interface RoleRetrieveParams {
136
178
  */
137
179
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
138
180
  }
139
- export interface RoleUpdateParams {
181
+ export interface RoleCreateParams {
182
+ /**
183
+ * Body param: Display name for the role, unique within the account.
184
+ */
185
+ name: string;
140
186
  /**
141
187
  * Query param: Sub-objects to expand in the response. When omitted, sub-objects
142
188
  * are returned as `null`.
143
189
  */
144
190
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
145
191
  /**
146
- * Body param: Display name.
147
- */
148
- name?: string;
149
- /**
150
- * Body param: Permissions in `<domain>:<action>` format. Replaces all existing
151
- * permissions; omit to leave unchanged.
192
+ * Body param: Permissions to grant, in `{domain}:{action}` format, such as
193
+ * `customers:read`.
194
+ *
195
+ * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
196
+ * create a role with no permissions.
152
197
  */
153
198
  permissions?: Array<string>;
154
199
  }
155
- export interface RoleListParams {
156
- /**
157
- * Cursor token used to retrieve the next or previous page of results.
158
- */
159
- cursor?: string;
200
+ export interface RoleUpdateParams {
160
201
  /**
161
- * Sub-objects to expand in the response. When omitted, sub-objects are returned as
162
- * `null`.
202
+ * Query param: Sub-objects to expand in the response. When omitted, sub-objects
203
+ * are returned as `null`.
163
204
  */
164
205
  include?: Array<'owner' | 'owner.account' | 'permissions'>;
165
206
  /**
166
- * Maximum number of results per page (default: 100, max: 1000).
167
- */
168
- limit?: number;
169
- /**
170
- * Search query used to filter results.
207
+ * Body param: New display name for the role, unique within the account.
208
+ *
209
+ * Omit to leave unchanged.
171
210
  */
172
- q?: string;
211
+ name?: string;
173
212
  /**
174
- * Filter by role types.
213
+ * Body param: Full replacement set of permissions, in `{domain}:{action}` format,
214
+ * such as `customers:read`.
215
+ *
216
+ * Replaces all existing permissions on the role. Pass an empty array to remove all
217
+ * permissions, or omit to leave them unchanged.
175
218
  */
176
- types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
219
+ permissions?: Array<string>;
177
220
  }
178
221
  export declare namespace Roles {
179
- export { type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleUpdateParams as RoleUpdateParams, type RoleListParams as RoleListParams, };
222
+ export { type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleListParams as RoleListParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleCreateParams as RoleCreateParams, type RoleUpdateParams as RoleUpdateParams, };
180
223
  }
181
224
  //# sourceMappingURL=roles.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
1
+ {"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -9,7 +9,40 @@ const path_1 = require("../../internal/utils/path.js");
9
9
  */
10
10
  class Roles extends resource_1.APIResource {
11
11
  /**
12
- * Creates a new role with the specified permissions.
12
+ * Returns a paginated list of roles for the target account, including global
13
+ * roles.
14
+ *
15
+ * This endpoint requires the permission: `roles:read`.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const listRole = await client.identity.roles.list();
20
+ * ```
21
+ */
22
+ list(query = {}, options) {
23
+ return this._client.get('/v1/identity/roles', { query, ...options });
24
+ }
25
+ /**
26
+ * Returns a role by ID, including its permissions.
27
+ *
28
+ * This endpoint requires the permission: `roles:read`.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const role = await client.identity.roles.retrieve(
33
+ * 'rl_01c16d2eb637c0d1f3a372937c',
34
+ * );
35
+ * ```
36
+ */
37
+ retrieve(id, query = {}, options) {
38
+ return this._client.get((0, path_1.path) `/v1/identity/roles/${id}`, { query, ...options });
39
+ }
40
+ /**
41
+ * Creates a custom role with the specified permissions.
42
+ *
43
+ * Roles created through the API always have type `user`.
44
+ *
45
+ * This endpoint requires the permission: `roles:create`.
13
46
  *
14
47
  * @example
15
48
  * ```ts
@@ -29,26 +62,20 @@ class Roles extends resource_1.APIResource {
29
62
  return this._client.post('/v1/identity/roles', { query: { include }, body, ...options });
30
63
  }
31
64
  /**
32
- * Returns a role by ID, including its structured permissions.
65
+ * Partially updates a custom role's name or permissions.
33
66
  *
34
- * @example
35
- * ```ts
36
- * const role = await client.identity.roles.retrieve(
37
- * 'rl_01c16d2eb637c0d1f3a372937c',
38
- * );
39
- * ```
40
- */
41
- retrieve(id, query = {}, options) {
42
- return this._client.get((0, path_1.path) `/v1/identity/roles/${id}`, { query, ...options });
43
- }
44
- /**
45
- * Partially updates a custom role's name or permissions. Provided permissions
46
- * replace all existing ones; global roles cannot be modified.
67
+ * Provided permissions replace all existing ones; global roles cannot be modified.
68
+ *
69
+ * This endpoint requires the permission: `roles:update`.
47
70
  *
48
71
  * @example
49
72
  * ```ts
50
73
  * const role = await client.identity.roles.update(
51
74
  * 'rl_01c16d2eb637c0d1f3a372937c',
75
+ * {
76
+ * name: 'Updated Manager',
77
+ * permissions: ['customers:read', 'customers:update'],
78
+ * },
52
79
  * );
53
80
  * ```
54
81
  */
@@ -57,19 +84,12 @@ class Roles extends resource_1.APIResource {
57
84
  return this._client.patch((0, path_1.path) `/v1/identity/roles/${id}`, { query: { include }, body, ...options });
58
85
  }
59
86
  /**
60
- * Returns a paginated list of roles for the target account, including global
61
- * roles.
87
+ * Deletes a role and its associated permissions.
62
88
  *
63
- * @example
64
- * ```ts
65
- * const listRole = await client.identity.roles.list();
66
- * ```
67
- */
68
- list(query = {}, options) {
69
- return this._client.get('/v1/identity/roles', { query, ...options });
70
- }
71
- /**
72
- * Deletes a role and its associated permissions. Global roles cannot be deleted.
89
+ * Global roles and roles currently assigned to one or more users cannot be
90
+ * deleted.
91
+ *
92
+ * This endpoint requires the permission: `roles:delete`.
73
93
  *
74
94
  * @example
75
95
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"roles.js","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAtFD,sBAsFC"}
1
+ {"version":3,"file":"roles.js","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AA1GD,sBA0GC"}