featurebase-node 0.14.3 → 0.15.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 (415) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/client.d.mts +11 -5
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +11 -5
  5. package/client.d.ts.map +1 -1
  6. package/client.js +6 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +6 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/audit-logs.d.mts +3 -3
  12. package/resources/audit-logs.d.mts.map +1 -1
  13. package/resources/audit-logs.d.ts +3 -3
  14. package/resources/audit-logs.d.ts.map +1 -1
  15. package/resources/changelogs/changelogs.d.mts +116 -116
  16. package/resources/changelogs/changelogs.d.mts.map +1 -1
  17. package/resources/changelogs/changelogs.d.ts +116 -116
  18. package/resources/changelogs/changelogs.d.ts.map +1 -1
  19. package/resources/changelogs/changelogs.js +74 -74
  20. package/resources/changelogs/changelogs.js.map +1 -1
  21. package/resources/changelogs/changelogs.mjs +74 -74
  22. package/resources/changelogs/changelogs.mjs.map +1 -1
  23. package/resources/changelogs/index.d.mts +1 -1
  24. package/resources/changelogs/index.d.mts.map +1 -1
  25. package/resources/changelogs/index.d.ts +1 -1
  26. package/resources/changelogs/index.d.ts.map +1 -1
  27. package/resources/changelogs/subscribers.d.mts +3 -3
  28. package/resources/changelogs/subscribers.d.mts.map +1 -1
  29. package/resources/changelogs/subscribers.d.ts +3 -3
  30. package/resources/changelogs/subscribers.d.ts.map +1 -1
  31. package/resources/conversation-attributes.d.mts +22 -17
  32. package/resources/conversation-attributes.d.mts.map +1 -1
  33. package/resources/conversation-attributes.d.ts +22 -17
  34. package/resources/conversation-attributes.d.ts.map +1 -1
  35. package/resources/conversation-attributes.js +19 -19
  36. package/resources/conversation-attributes.js.map +1 -1
  37. package/resources/conversation-attributes.mjs +19 -19
  38. package/resources/conversation-attributes.mjs.map +1 -1
  39. package/resources/feedback/boards.d.mts +19 -19
  40. package/resources/feedback/boards.d.mts.map +1 -1
  41. package/resources/feedback/boards.d.ts +19 -19
  42. package/resources/feedback/boards.d.ts.map +1 -1
  43. package/resources/feedback/boards.js +20 -20
  44. package/resources/feedback/boards.js.map +1 -1
  45. package/resources/feedback/boards.mjs +20 -20
  46. package/resources/feedback/boards.mjs.map +1 -1
  47. package/resources/feedback/comments.d.mts +113 -113
  48. package/resources/feedback/comments.d.mts.map +1 -1
  49. package/resources/feedback/comments.d.ts +113 -113
  50. package/resources/feedback/comments.d.ts.map +1 -1
  51. package/resources/feedback/comments.js +93 -93
  52. package/resources/feedback/comments.js.map +1 -1
  53. package/resources/feedback/comments.mjs +93 -93
  54. package/resources/feedback/comments.mjs.map +1 -1
  55. package/resources/feedback/custom-fields.d.mts +36 -36
  56. package/resources/feedback/custom-fields.d.mts.map +1 -1
  57. package/resources/feedback/custom-fields.d.ts +36 -36
  58. package/resources/feedback/custom-fields.d.ts.map +1 -1
  59. package/resources/feedback/custom-fields.js +36 -36
  60. package/resources/feedback/custom-fields.js.map +1 -1
  61. package/resources/feedback/custom-fields.mjs +36 -36
  62. package/resources/feedback/custom-fields.mjs.map +1 -1
  63. package/resources/feedback/feedback.d.mts +5 -5
  64. package/resources/feedback/feedback.d.mts.map +1 -1
  65. package/resources/feedback/feedback.d.ts +5 -5
  66. package/resources/feedback/feedback.d.ts.map +1 -1
  67. package/resources/feedback/index.d.mts +5 -5
  68. package/resources/feedback/index.d.mts.map +1 -1
  69. package/resources/feedback/index.d.ts +5 -5
  70. package/resources/feedback/index.d.ts.map +1 -1
  71. package/resources/feedback/post-statuses.d.mts +20 -20
  72. package/resources/feedback/post-statuses.d.mts.map +1 -1
  73. package/resources/feedback/post-statuses.d.ts +20 -20
  74. package/resources/feedback/post-statuses.d.ts.map +1 -1
  75. package/resources/feedback/post-statuses.js +23 -23
  76. package/resources/feedback/post-statuses.js.map +1 -1
  77. package/resources/feedback/post-statuses.mjs +23 -23
  78. package/resources/feedback/post-statuses.mjs.map +1 -1
  79. package/resources/feedback/posts/index.d.mts +1 -1
  80. package/resources/feedback/posts/index.d.mts.map +1 -1
  81. package/resources/feedback/posts/index.d.ts +1 -1
  82. package/resources/feedback/posts/index.d.ts.map +1 -1
  83. package/resources/feedback/posts/posts.d.mts +132 -132
  84. package/resources/feedback/posts/posts.d.mts.map +1 -1
  85. package/resources/feedback/posts/posts.d.ts +132 -132
  86. package/resources/feedback/posts/posts.d.ts.map +1 -1
  87. package/resources/feedback/posts/posts.js +107 -107
  88. package/resources/feedback/posts/posts.js.map +1 -1
  89. package/resources/feedback/posts/posts.mjs +107 -107
  90. package/resources/feedback/posts/posts.mjs.map +1 -1
  91. package/resources/feedback/posts/voters.d.mts +3 -3
  92. package/resources/feedback/posts/voters.d.mts.map +1 -1
  93. package/resources/feedback/posts/voters.d.ts +3 -3
  94. package/resources/feedback/posts/voters.d.ts.map +1 -1
  95. package/resources/help-center/articles.d.mts +213 -97
  96. package/resources/help-center/articles.d.mts.map +1 -1
  97. package/resources/help-center/articles.d.ts +213 -97
  98. package/resources/help-center/articles.d.ts.map +1 -1
  99. package/resources/help-center/articles.js +73 -73
  100. package/resources/help-center/articles.js.map +1 -1
  101. package/resources/help-center/articles.mjs +73 -73
  102. package/resources/help-center/articles.mjs.map +1 -1
  103. package/resources/help-center/collections.d.mts +158 -71
  104. package/resources/help-center/collections.d.mts.map +1 -1
  105. package/resources/help-center/collections.d.ts +158 -71
  106. package/resources/help-center/collections.d.ts.map +1 -1
  107. package/resources/help-center/collections.js +65 -65
  108. package/resources/help-center/collections.js.map +1 -1
  109. package/resources/help-center/collections.mjs +65 -65
  110. package/resources/help-center/collections.mjs.map +1 -1
  111. package/resources/help-center/help-center.d.mts +4 -4
  112. package/resources/help-center/help-center.d.mts.map +1 -1
  113. package/resources/help-center/help-center.d.ts +4 -4
  114. package/resources/help-center/help-center.d.ts.map +1 -1
  115. package/resources/help-center/help-centers.d.mts +77 -48
  116. package/resources/help-center/help-centers.d.mts.map +1 -1
  117. package/resources/help-center/help-centers.d.ts +77 -48
  118. package/resources/help-center/help-centers.d.ts.map +1 -1
  119. package/resources/help-center/help-centers.js +43 -43
  120. package/resources/help-center/help-centers.js.map +1 -1
  121. package/resources/help-center/help-centers.mjs +43 -43
  122. package/resources/help-center/help-centers.mjs.map +1 -1
  123. package/resources/help-center/index.d.mts +4 -4
  124. package/resources/help-center/index.d.mts.map +1 -1
  125. package/resources/help-center/index.d.ts +4 -4
  126. package/resources/help-center/index.d.ts.map +1 -1
  127. package/resources/help-center/redirect-rules.d.mts +124 -124
  128. package/resources/help-center/redirect-rules.d.mts.map +1 -1
  129. package/resources/help-center/redirect-rules.d.ts +124 -124
  130. package/resources/help-center/redirect-rules.d.ts.map +1 -1
  131. package/resources/help-center/redirect-rules.js +112 -112
  132. package/resources/help-center/redirect-rules.js.map +1 -1
  133. package/resources/help-center/redirect-rules.mjs +112 -112
  134. package/resources/help-center/redirect-rules.mjs.map +1 -1
  135. package/resources/index.d.mts +6 -5
  136. package/resources/index.d.mts.map +1 -1
  137. package/resources/index.d.ts +6 -5
  138. package/resources/index.d.ts.map +1 -1
  139. package/resources/index.js +3 -1
  140. package/resources/index.js.map +1 -1
  141. package/resources/index.mjs +1 -0
  142. package/resources/index.mjs.map +1 -1
  143. package/resources/organization/admins.d.mts +26 -26
  144. package/resources/organization/admins.d.mts.map +1 -1
  145. package/resources/organization/admins.d.ts +26 -26
  146. package/resources/organization/admins.d.ts.map +1 -1
  147. package/resources/organization/admins.js +25 -25
  148. package/resources/organization/admins.js.map +1 -1
  149. package/resources/organization/admins.mjs +25 -25
  150. package/resources/organization/admins.mjs.map +1 -1
  151. package/resources/organization/brands.d.mts +52 -52
  152. package/resources/organization/brands.d.mts.map +1 -1
  153. package/resources/organization/brands.d.ts +52 -52
  154. package/resources/organization/brands.d.ts.map +1 -1
  155. package/resources/organization/brands.js +54 -54
  156. package/resources/organization/brands.js.map +1 -1
  157. package/resources/organization/brands.mjs +54 -54
  158. package/resources/organization/brands.mjs.map +1 -1
  159. package/resources/organization/index.d.mts +3 -3
  160. package/resources/organization/index.d.mts.map +1 -1
  161. package/resources/organization/index.d.ts +3 -3
  162. package/resources/organization/index.d.ts.map +1 -1
  163. package/resources/organization/organization.d.mts +3 -3
  164. package/resources/organization/organization.d.mts.map +1 -1
  165. package/resources/organization/organization.d.ts +3 -3
  166. package/resources/organization/organization.d.ts.map +1 -1
  167. package/resources/organization/teams.d.mts +47 -47
  168. package/resources/organization/teams.d.mts.map +1 -1
  169. package/resources/organization/teams.d.ts +47 -47
  170. package/resources/organization/teams.d.ts.map +1 -1
  171. package/resources/organization/teams.js +44 -44
  172. package/resources/organization/teams.js.map +1 -1
  173. package/resources/organization/teams.mjs +44 -44
  174. package/resources/organization/teams.mjs.map +1 -1
  175. package/resources/reports.d.mts +339 -223
  176. package/resources/reports.d.mts.map +1 -1
  177. package/resources/reports.d.ts +339 -223
  178. package/resources/reports.d.ts.map +1 -1
  179. package/resources/reports.js +114 -107
  180. package/resources/reports.js.map +1 -1
  181. package/resources/reports.mjs +114 -107
  182. package/resources/reports.mjs.map +1 -1
  183. package/resources/support/conversation-tags.d.mts +43 -43
  184. package/resources/support/conversation-tags.d.mts.map +1 -1
  185. package/resources/support/conversation-tags.d.ts +43 -43
  186. package/resources/support/conversation-tags.d.ts.map +1 -1
  187. package/resources/support/conversation-tags.js +32 -32
  188. package/resources/support/conversation-tags.js.map +1 -1
  189. package/resources/support/conversation-tags.mjs +32 -32
  190. package/resources/support/conversation-tags.mjs.map +1 -1
  191. package/resources/support/conversations/conversations.d.mts +363 -332
  192. package/resources/support/conversations/conversations.d.mts.map +1 -1
  193. package/resources/support/conversations/conversations.d.ts +363 -332
  194. package/resources/support/conversations/conversations.d.ts.map +1 -1
  195. package/resources/support/conversations/conversations.js +293 -283
  196. package/resources/support/conversations/conversations.js.map +1 -1
  197. package/resources/support/conversations/conversations.mjs +293 -283
  198. package/resources/support/conversations/conversations.mjs.map +1 -1
  199. package/resources/support/conversations/index.d.mts +1 -1
  200. package/resources/support/conversations/index.d.mts.map +1 -1
  201. package/resources/support/conversations/index.d.ts +1 -1
  202. package/resources/support/conversations/index.d.ts.map +1 -1
  203. package/resources/support/conversations/participants.d.mts +2 -2
  204. package/resources/support/conversations/participants.d.mts.map +1 -1
  205. package/resources/support/conversations/participants.d.ts +2 -2
  206. package/resources/support/conversations/participants.d.ts.map +1 -1
  207. package/resources/support/index.d.mts +3 -3
  208. package/resources/support/index.d.mts.map +1 -1
  209. package/resources/support/index.d.ts +3 -3
  210. package/resources/support/index.d.ts.map +1 -1
  211. package/resources/support/support.d.mts +3 -3
  212. package/resources/support/support.d.mts.map +1 -1
  213. package/resources/support/support.d.ts +3 -3
  214. package/resources/support/support.d.ts.map +1 -1
  215. package/resources/support/tickets/categories.d.mts +20 -20
  216. package/resources/support/tickets/categories.d.mts.map +1 -1
  217. package/resources/support/tickets/categories.d.ts +20 -20
  218. package/resources/support/tickets/categories.d.ts.map +1 -1
  219. package/resources/support/tickets/categories.js +25 -25
  220. package/resources/support/tickets/categories.js.map +1 -1
  221. package/resources/support/tickets/categories.mjs +25 -25
  222. package/resources/support/tickets/categories.mjs.map +1 -1
  223. package/resources/support/tickets/custom-fields.d.mts +22 -22
  224. package/resources/support/tickets/custom-fields.d.mts.map +1 -1
  225. package/resources/support/tickets/custom-fields.d.ts +22 -22
  226. package/resources/support/tickets/custom-fields.d.ts.map +1 -1
  227. package/resources/support/tickets/custom-fields.js +19 -19
  228. package/resources/support/tickets/custom-fields.js.map +1 -1
  229. package/resources/support/tickets/custom-fields.mjs +19 -19
  230. package/resources/support/tickets/custom-fields.mjs.map +1 -1
  231. package/resources/support/tickets/index.d.mts +4 -4
  232. package/resources/support/tickets/index.d.mts.map +1 -1
  233. package/resources/support/tickets/index.d.ts +4 -4
  234. package/resources/support/tickets/index.d.ts.map +1 -1
  235. package/resources/support/tickets/statuses.d.mts +19 -19
  236. package/resources/support/tickets/statuses.d.mts.map +1 -1
  237. package/resources/support/tickets/statuses.d.ts +19 -19
  238. package/resources/support/tickets/statuses.d.ts.map +1 -1
  239. package/resources/support/tickets/statuses.js +21 -21
  240. package/resources/support/tickets/statuses.js.map +1 -1
  241. package/resources/support/tickets/statuses.mjs +21 -21
  242. package/resources/support/tickets/statuses.mjs.map +1 -1
  243. package/resources/support/tickets/tickets.d.mts +75 -75
  244. package/resources/support/tickets/tickets.d.mts.map +1 -1
  245. package/resources/support/tickets/tickets.d.ts +75 -75
  246. package/resources/support/tickets/tickets.d.ts.map +1 -1
  247. package/resources/support/tickets/tickets.js +44 -44
  248. package/resources/support/tickets/tickets.js.map +1 -1
  249. package/resources/support/tickets/tickets.mjs +44 -44
  250. package/resources/support/tickets/tickets.mjs.map +1 -1
  251. package/resources/surveys.d.mts +43 -43
  252. package/resources/surveys.d.mts.map +1 -1
  253. package/resources/surveys.d.ts +43 -43
  254. package/resources/surveys.d.ts.map +1 -1
  255. package/resources/surveys.js +44 -44
  256. package/resources/surveys.js.map +1 -1
  257. package/resources/surveys.mjs +44 -44
  258. package/resources/surveys.mjs.map +1 -1
  259. package/resources/training-data/files.d.mts +292 -0
  260. package/resources/training-data/files.d.mts.map +1 -0
  261. package/resources/training-data/files.d.ts +292 -0
  262. package/resources/training-data/files.d.ts.map +1 -0
  263. package/resources/training-data/files.js +171 -0
  264. package/resources/training-data/files.js.map +1 -0
  265. package/resources/training-data/files.mjs +167 -0
  266. package/resources/training-data/files.mjs.map +1 -0
  267. package/resources/training-data/index.d.mts +4 -0
  268. package/resources/training-data/index.d.mts.map +1 -0
  269. package/resources/training-data/index.d.ts +4 -0
  270. package/resources/training-data/index.d.ts.map +1 -0
  271. package/resources/training-data/index.js +11 -0
  272. package/resources/training-data/index.js.map +1 -0
  273. package/resources/training-data/index.mjs +5 -0
  274. package/resources/training-data/index.mjs.map +1 -0
  275. package/resources/training-data/qna.d.mts +370 -0
  276. package/resources/training-data/qna.d.mts.map +1 -0
  277. package/resources/training-data/qna.d.ts +370 -0
  278. package/resources/training-data/qna.d.ts.map +1 -0
  279. package/resources/training-data/qna.js +177 -0
  280. package/resources/training-data/qna.js.map +1 -0
  281. package/resources/training-data/qna.mjs +173 -0
  282. package/resources/training-data/qna.mjs.map +1 -0
  283. package/resources/training-data/training-data.d.mts +442 -0
  284. package/resources/training-data/training-data.d.mts.map +1 -0
  285. package/resources/training-data/training-data.d.ts +442 -0
  286. package/resources/training-data/training-data.d.ts.map +1 -0
  287. package/resources/training-data/training-data.js +105 -0
  288. package/resources/training-data/training-data.js.map +1 -0
  289. package/resources/training-data/training-data.mjs +100 -0
  290. package/resources/training-data/training-data.mjs.map +1 -0
  291. package/resources/training-data.d.mts +2 -0
  292. package/resources/training-data.d.mts.map +1 -0
  293. package/resources/training-data.d.ts +2 -0
  294. package/resources/training-data.d.ts.map +1 -0
  295. package/resources/training-data.js +6 -0
  296. package/resources/training-data.js.map +1 -0
  297. package/resources/training-data.mjs +3 -0
  298. package/resources/training-data.mjs.map +1 -0
  299. package/resources/users/companies/companies.d.mts +121 -130
  300. package/resources/users/companies/companies.d.mts.map +1 -1
  301. package/resources/users/companies/companies.d.ts +121 -130
  302. package/resources/users/companies/companies.d.ts.map +1 -1
  303. package/resources/users/companies/companies.js +125 -125
  304. package/resources/users/companies/companies.js.map +1 -1
  305. package/resources/users/companies/companies.mjs +125 -125
  306. package/resources/users/companies/companies.mjs.map +1 -1
  307. package/resources/users/companies/contacts.d.mts +3 -3
  308. package/resources/users/companies/contacts.d.mts.map +1 -1
  309. package/resources/users/companies/contacts.d.ts +3 -3
  310. package/resources/users/companies/contacts.d.ts.map +1 -1
  311. package/resources/users/companies/index.d.mts +1 -1
  312. package/resources/users/companies/index.d.mts.map +1 -1
  313. package/resources/users/companies/index.d.ts +1 -1
  314. package/resources/users/companies/index.d.ts.map +1 -1
  315. package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
  316. package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
  317. package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
  318. package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
  319. package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
  320. package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
  321. package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
  322. package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
  323. package/resources/users/contacts/contacts.d.mts +249 -235
  324. package/resources/users/contacts/contacts.d.mts.map +1 -1
  325. package/resources/users/contacts/contacts.d.ts +249 -235
  326. package/resources/users/contacts/contacts.d.ts.map +1 -1
  327. package/resources/users/contacts/contacts.js +211 -184
  328. package/resources/users/contacts/contacts.js.map +1 -1
  329. package/resources/users/contacts/contacts.mjs +211 -184
  330. package/resources/users/contacts/contacts.mjs.map +1 -1
  331. package/resources/users/contacts/email-preferences.d.mts +2 -2
  332. package/resources/users/contacts/email-preferences.d.mts.map +1 -1
  333. package/resources/users/contacts/email-preferences.d.ts +2 -2
  334. package/resources/users/contacts/email-preferences.d.ts.map +1 -1
  335. package/resources/users/contacts/index.d.mts +1 -1
  336. package/resources/users/contacts/index.d.mts.map +1 -1
  337. package/resources/users/contacts/index.d.ts +1 -1
  338. package/resources/users/contacts/index.d.ts.map +1 -1
  339. package/resources/users/index.d.mts +2 -2
  340. package/resources/users/index.d.mts.map +1 -1
  341. package/resources/users/index.d.ts +2 -2
  342. package/resources/users/index.d.ts.map +1 -1
  343. package/resources/users/users.d.mts +2 -2
  344. package/resources/users/users.d.mts.map +1 -1
  345. package/resources/users/users.d.ts +2 -2
  346. package/resources/users/users.d.ts.map +1 -1
  347. package/resources/webhooks.d.mts +83 -83
  348. package/resources/webhooks.d.mts.map +1 -1
  349. package/resources/webhooks.d.ts +83 -83
  350. package/resources/webhooks.d.ts.map +1 -1
  351. package/resources/webhooks.js +77 -77
  352. package/resources/webhooks.js.map +1 -1
  353. package/resources/webhooks.mjs +77 -77
  354. package/resources/webhooks.mjs.map +1 -1
  355. package/src/client.ts +26 -6
  356. package/src/resources/audit-logs.ts +19 -1
  357. package/src/resources/changelogs/changelogs.ts +320 -175
  358. package/src/resources/changelogs/index.ts +1 -1
  359. package/src/resources/changelogs/subscribers.ts +31 -2
  360. package/src/resources/conversation-attributes.ts +40 -34
  361. package/src/resources/feedback/boards.ts +30 -30
  362. package/src/resources/feedback/comments.ts +137 -137
  363. package/src/resources/feedback/custom-fields.ts +46 -46
  364. package/src/resources/feedback/feedback.ts +6 -6
  365. package/src/resources/feedback/index.ts +6 -6
  366. package/src/resources/feedback/post-statuses.ts +33 -33
  367. package/src/resources/feedback/posts/index.ts +2 -2
  368. package/src/resources/feedback/posts/posts.ts +176 -176
  369. package/src/resources/feedback/posts/voters.ts +3 -3
  370. package/src/resources/help-center/articles.ts +631 -109
  371. package/src/resources/help-center/collections.ts +349 -88
  372. package/src/resources/help-center/help-center.ts +5 -5
  373. package/src/resources/help-center/help-centers.ts +202 -57
  374. package/src/resources/help-center/index.ts +5 -5
  375. package/src/resources/help-center/redirect-rules.ts +294 -178
  376. package/src/resources/index.ts +13 -6
  377. package/src/resources/organization/admins.ts +36 -36
  378. package/src/resources/organization/brands.ts +68 -68
  379. package/src/resources/organization/index.ts +3 -3
  380. package/src/resources/organization/organization.ts +3 -3
  381. package/src/resources/organization/teams.ts +54 -54
  382. package/src/resources/reports.ts +462 -272
  383. package/src/resources/support/conversation-tags.ts +62 -62
  384. package/src/resources/support/conversations/conversations.ts +453 -417
  385. package/src/resources/support/conversations/index.ts +4 -4
  386. package/src/resources/support/conversations/participants.ts +2 -2
  387. package/src/resources/support/index.ts +7 -7
  388. package/src/resources/support/support.ts +7 -7
  389. package/src/resources/support/tickets/categories.ts +35 -35
  390. package/src/resources/support/tickets/custom-fields.ts +29 -29
  391. package/src/resources/support/tickets/index.ts +4 -4
  392. package/src/resources/support/tickets/statuses.ts +31 -31
  393. package/src/resources/support/tickets/tickets.ts +101 -101
  394. package/src/resources/surveys.ts +60 -60
  395. package/src/resources/training-data/files.ts +431 -0
  396. package/src/resources/training-data/index.ts +31 -0
  397. package/src/resources/training-data/qna.ts +514 -0
  398. package/src/resources/training-data/training-data.ts +603 -0
  399. package/src/resources/training-data.ts +3 -0
  400. package/src/resources/users/companies/companies.ts +158 -172
  401. package/src/resources/users/companies/contacts.ts +3 -3
  402. package/src/resources/users/companies/index.ts +2 -2
  403. package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
  404. package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
  405. package/src/resources/users/contacts/contacts.ts +284 -280
  406. package/src/resources/users/contacts/email-preferences.ts +2 -2
  407. package/src/resources/users/contacts/index.ts +3 -3
  408. package/src/resources/users/index.ts +5 -5
  409. package/src/resources/users/users.ts +5 -5
  410. package/src/resources/webhooks.ts +106 -100
  411. package/src/version.ts +1 -1
  412. package/version.d.mts +1 -1
  413. package/version.d.ts +1 -1
  414. package/version.js +1 -1
  415. package/version.mjs +1 -1
@@ -13,77 +13,6 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
13
13
  */
14
14
  export declare class Conversations extends APIResource {
15
15
  participants: ParticipantsAPI.Participants;
16
- /**
17
- * Returns a list of conversations in your organization using cursor-based
18
- * pagination.
19
- *
20
- * ### Query Parameters
21
- *
22
- * - `limit` - Number of conversations to return (1-100, default 10)
23
- * - `cursor` - Cursor from previous response for pagination
24
- * - `tagIds` - Optional tag filter as a comma-separated list of tag IDs. Matches
25
- * conversations that contain all of the provided tags.
26
- *
27
- * ### Response Format
28
- *
29
- * Returns a list object with:
30
- *
31
- * - `object` - Always "list"
32
- * - `data` - Array of conversation objects
33
- * - `nextCursor` - Cursor for the next page, or null if no more results
34
- *
35
- * ### Conversation Object
36
- *
37
- * Each conversation includes:
38
- *
39
- * - `id` - Unique conversation identifier (short ID)
40
- * - `title` - Conversation title
41
- * - `state` - Current state ("open", "closed", or "snoozed")
42
- * - `priority` - Whether the conversation is marked as priority
43
- * - `adminAssigneeId` - ID of assigned admin (if any)
44
- * - `teamAssigneeId` - ID of assigned team (if any)
45
- * - `tags` - Current tags applied anywhere in the conversation
46
- * - `participants` - Array of participants
47
- * - `source` - Information about the first message
48
- * - `createdAt` - Creation timestamp
49
- * - `updatedAt` - Last update timestamp
50
- *
51
- * ### Example
52
- *
53
- * ```json
54
- * {
55
- * "object": "list",
56
- * "data": [
57
- * {
58
- * "object": "conversation",
59
- * "id": "12345",
60
- * "title": "Question about pricing",
61
- * "state": "open",
62
- * "priority": false,
63
- * "adminAssigneeId": null,
64
- * "participants": [
65
- * { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
66
- * ],
67
- * ...
68
- * }
69
- * ],
70
- * "nextCursor": "eyJpZCI6IjEyMzQ1In0="
71
- * }
72
- * ```
73
- *
74
- * ### Version Availability
75
- *
76
- * This endpoint is only available in API version 2026-01-01.nova and newer.
77
- *
78
- * @example
79
- * ```ts
80
- * // Automatically fetches more pages as needed.
81
- * for await (const conversation of client.support.conversations.list()) {
82
- * // ...
83
- * }
84
- * ```
85
- */
86
- list(params?: ConversationListParams | null | undefined, options?: RequestOptions): PagePromise<ConversationsCursorPage, Conversation>;
87
16
  /**
88
17
  * Creates a new conversation. Supports both contact-initiated (customer/lead) and
89
18
  * admin-initiated (outreach) conversations.
@@ -323,41 +252,6 @@ export declare class Conversations extends APIResource {
323
252
  * ```
324
253
  */
325
254
  retrieve(id: string, params?: ConversationRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Conversation>;
326
- /**
327
- * Permanently deletes a conversation by its short ID.
328
- *
329
- * ### Path Parameters
330
- *
331
- * - `id` - The conversation short ID (numeric)
332
- *
333
- * ### Response
334
- *
335
- * Returns a deletion confirmation object:
336
- *
337
- * ```json
338
- * {
339
- * "id": "12345",
340
- * "object": "conversation",
341
- * "deleted": true
342
- * }
343
- * ```
344
- *
345
- * ### Caution
346
- *
347
- * This operation is **irreversible**. The conversation and all its messages will
348
- * be permanently deleted.
349
- *
350
- * ### Version Availability
351
- *
352
- * This endpoint is only available in API version 2026-01-01.nova and newer.
353
- *
354
- * @example
355
- * ```ts
356
- * const conversation =
357
- * await client.support.conversations.delete('12345');
358
- * ```
359
- */
360
- delete(id: string, params?: ConversationDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationDeleteResponse>;
361
255
  /**
362
256
  * Updates a conversation's properties. Supports partial updates - only provided
363
257
  * fields will be updated.
@@ -487,97 +381,195 @@ export declare class Conversations extends APIResource {
487
381
  */
488
382
  update(id: string, params: ConversationUpdateParams, options?: RequestOptions): APIPromise<Conversation>;
489
383
  /**
490
- * Adds a reply to an existing conversation. Supports both contact (customer/lead)
491
- * and admin replies.
384
+ * Returns a list of conversations in your organization using cursor-based
385
+ * pagination.
492
386
  *
493
- * ### Path Parameters
387
+ * ### Query Parameters
494
388
  *
495
- * - `id` - The conversation ID (short ID)
389
+ * - `limit` - Number of conversations to return (1-100, default 10)
390
+ * - `cursor` - Cursor from previous response for pagination
391
+ * - `tagIds` - Optional tag filter as a comma-separated list of tag IDs. Matches
392
+ * conversations that contain all of the provided tags.
496
393
  *
497
- * ### Request Body
394
+ * ### Response Format
498
395
  *
499
- * The request body varies based on who is sending the reply:
396
+ * Returns a list object with:
500
397
  *
501
- * #### Contact Reply (customer/lead)
398
+ * - `object` - Always "list"
399
+ * - `data` - Array of conversation objects
400
+ * - `nextCursor` - Cursor for the next page, or null if no more results
502
401
  *
503
- * | Field | Type | Required | Description |
504
- * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
505
- * | `type` | string | Yes | Must be "contact" |
506
- * | `userId` | string | No\* | External user ID from your system |
507
- * | `id` | string | No\* | Featurebase contact ID (24-character ObjectId) |
508
- * | `bodyMarkdown` | string | Yes | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
509
- * | `messageType` | string | Yes | Must be "reply" |
510
- * | `skipNotifications` | boolean | No | Skip sending notifications (default: false). Useful for bulk imports. |
402
+ * ### Conversation Object
511
403
  *
512
- * \*At least one of `userId` or `id` is required.
404
+ * Each conversation includes:
513
405
  *
514
- * #### Admin Reply
406
+ * - `id` - Unique conversation identifier (short ID)
407
+ * - `title` - Conversation title
408
+ * - `state` - Current state ("open", "closed", or "snoozed")
409
+ * - `priority` - Whether the conversation is marked as priority
410
+ * - `adminAssigneeId` - ID of assigned admin (if any)
411
+ * - `teamAssigneeId` - ID of assigned team (if any)
412
+ * - `tags` - Current tags applied anywhere in the conversation
413
+ * - `participants` - Array of participants
414
+ * - `source` - Information about the first message
415
+ * - `createdAt` - Creation timestamp
416
+ * - `updatedAt` - Last update timestamp
515
417
  *
516
- * | Field | Type | Required | Description |
517
- * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
518
- * | `type` | string | Yes | Must be "admin" |
519
- * | `id` | string | Yes | Featurebase admin ID (24-character ObjectId) |
520
- * | `bodyMarkdown` | string | Yes | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
521
- * | `messageType` | string | Yes | "reply" for customer-visible reply, "note" for internal note |
522
- * | `skipNotifications` | boolean | No | Skip sending notifications (default: false). Useful for bulk imports. |
418
+ * ### Example
523
419
  *
524
- * ### Response
420
+ * ```json
421
+ * {
422
+ * "object": "list",
423
+ * "data": [
424
+ * {
425
+ * "object": "conversation",
426
+ * "id": "12345",
427
+ * "title": "Question about pricing",
428
+ * "state": "open",
429
+ * "priority": false,
430
+ * "adminAssigneeId": null,
431
+ * "participants": [
432
+ * { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
433
+ * ],
434
+ * ...
435
+ * }
436
+ * ],
437
+ * "nextCursor": "eyJpZCI6IjEyMzQ1In0="
438
+ * }
439
+ * ```
525
440
  *
526
- * Returns the created conversation part object with a **201 Created** status. The
527
- * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
528
- * fields.
441
+ * ### Version Availability
529
442
  *
530
- * ### Example Contact Reply
443
+ * This endpoint is only available in API version 2026-01-01.nova and newer.
531
444
  *
532
- * ```json
533
- * {
534
- * "type": "contact",
535
- * "userId": "user_123",
536
- * "bodyMarkdown": "Thank you for your help!",
537
- * "messageType": "reply"
445
+ * @example
446
+ * ```ts
447
+ * // Automatically fetches more pages as needed.
448
+ * for await (const conversation of client.support.conversations.list()) {
449
+ * // ...
538
450
  * }
539
451
  * ```
452
+ */
453
+ list(params?: ConversationListParams | null | undefined, options?: RequestOptions): PagePromise<ConversationsCursorPage, Conversation>;
454
+ /**
455
+ * Permanently deletes a conversation by its short ID.
540
456
  *
541
- * ### Example Admin Reply
457
+ * ### Path Parameters
458
+ *
459
+ * - `id` - The conversation short ID (numeric)
460
+ *
461
+ * ### Response
462
+ *
463
+ * Returns a deletion confirmation object:
542
464
  *
543
465
  * ```json
544
466
  * {
545
- * "type": "admin",
546
- * "id": "507f1f77bcf86cd799439011",
547
- * "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
548
- * "messageType": "reply"
467
+ * "id": "12345",
468
+ * "object": "conversation",
469
+ * "deleted": true
549
470
  * }
550
471
  * ```
551
472
  *
552
- * ### Example Admin Note (Internal)
473
+ * ### Caution
474
+ *
475
+ * This operation is **irreversible**. The conversation and all its messages will
476
+ * be permanently deleted.
477
+ *
478
+ * ### Version Availability
479
+ *
480
+ * This endpoint is only available in API version 2026-01-01.nova and newer.
481
+ *
482
+ * @example
483
+ * ```ts
484
+ * const conversation =
485
+ * await client.support.conversations.delete('12345');
486
+ * ```
487
+ */
488
+ delete(id: string, params?: ConversationDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationDeleteResponse>;
489
+ /**
490
+ * Attaches a workspace tag to a conversation.
491
+ *
492
+ * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
493
+ * admin on whose behalf the mutation is recorded.
494
+ *
495
+ * ### Path Parameters
496
+ *
497
+ * - `id` - The conversation ID (short ID)
498
+ *
499
+ * ### Request Body
500
+ *
501
+ * | Field | Type | Required | Description |
502
+ * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
503
+ * | `tagId` | string | Yes | The Featurebase tag ID to attach |
504
+ * | `actingAdminId` | string | Yes | The admin performing the mutation. Must be a member of the organization. |
505
+ *
506
+ * ### Behavior
507
+ *
508
+ * Featurebase resolves the latest taggable reply/message in the conversation and
509
+ * records the tag attachment against that part so audit metadata remains
510
+ * deterministic.
511
+ *
512
+ * ### Response
513
+ *
514
+ * Returns the affected tag plus attachment metadata such as `targetPartId`,
515
+ * `appliedAt`, and `appliedBy`.
516
+ *
517
+ * ### Example Request
553
518
  *
554
519
  * ```json
555
520
  * {
556
- * "type": "admin",
557
- * "id": "507f1f77bcf86cd799439011",
558
- * "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
559
- * "messageType": "note"
521
+ * "tagId": "67ec1234abcd5678ef901234",
522
+ * "actingAdminId": "507f1f77bcf86cd799439011"
560
523
  * }
561
524
  * ```
562
525
  *
563
- * ### Example Response
526
+ * ### Version Availability
527
+ *
528
+ * This endpoint is only available in API version 2026-01-01.nova and newer.
529
+ *
530
+ * @example
531
+ * ```ts
532
+ * const attachedConversationTag =
533
+ * await client.support.conversations.attachTag('12345', {
534
+ * actingAdminId: '507f1f77bcf86cd799439011',
535
+ * tagId: '67ec1234abcd5678ef901234',
536
+ * });
537
+ * ```
538
+ */
539
+ attachTag(id: string, params: ConversationAttachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
540
+ /**
541
+ * Removes a workspace tag from a conversation.
542
+ *
543
+ * This endpoint requires the `actingAdminId` of the admin on whose behalf the
544
+ * mutation is recorded.
545
+ *
546
+ * ### Path Parameters
547
+ *
548
+ * - `id` - The conversation ID (short ID)
549
+ * - `tagId` - The Featurebase tag ID to remove
550
+ *
551
+ * ### Request Body
552
+ *
553
+ * | Field | Type | Required | Description |
554
+ * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
555
+ * | `actingAdminId` | string | Yes | The admin performing the mutation. Must be a member of the organization. |
556
+ *
557
+ * ### Behavior
558
+ *
559
+ * Featurebase resolves the latest taggable reply/message in the conversation and
560
+ * records the tag removal against that part so audit metadata remains
561
+ * deterministic.
562
+ *
563
+ * ### Response
564
+ *
565
+ * Returns the affected tag payload with the most relevant attachment metadata
566
+ * available for that relationship.
567
+ *
568
+ * ### Example Request
564
569
  *
565
570
  * ```json
566
571
  * {
567
- * "object": "conversation_part",
568
- * "id": "3",
569
- * "partType": "user_msg",
570
- * "bodyHtml": "<p>Thank you for your help!</p>",
571
- * "bodyMarkdown": "Thank you for your help!",
572
- * "author": {
573
- * "type": "customer",
574
- * "id": "676f0f6765bdaa7d7d760f88",
575
- * "name": "John Doe",
576
- * "email": "john@example.com"
577
- * },
578
- * "channel": "desktop",
579
- * "createdAt": "2025-01-15T10:40:00.000Z",
580
- * "updatedAt": "2025-01-15T10:40:00.000Z"
572
+ * "actingAdminId": "507f1f77bcf86cd799439011"
581
573
  * }
582
574
  * ```
583
575
  *
@@ -587,15 +579,17 @@ export declare class Conversations extends APIResource {
587
579
  *
588
580
  * @example
589
581
  * ```ts
590
- * const conversationPart =
591
- * await client.support.conversations.reply('12345', {
592
- * bodyMarkdown: 'Thank you for your help!',
593
- * messageType: 'reply',
594
- * type: 'contact',
595
- * });
582
+ * const attachedConversationTag =
583
+ * await client.support.conversations.detachTag(
584
+ * '67ec1234abcd5678ef901234',
585
+ * {
586
+ * id: '12345',
587
+ * actingAdminId: '507f1f77bcf86cd799439011',
588
+ * },
589
+ * );
596
590
  * ```
597
591
  */
598
- reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart>;
592
+ detachTag(tagID: string, params: ConversationDetachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
599
593
  /**
600
594
  * Redacts a conversation part (message) from a conversation. Redaction permanently
601
595
  * removes the message content while preserving the conversation structure.
@@ -676,10 +670,8 @@ export declare class Conversations extends APIResource {
676
670
  */
677
671
  redact(params: ConversationRedactParams, options?: RequestOptions): APIPromise<Conversation>;
678
672
  /**
679
- * Attaches a workspace tag to a conversation.
680
- *
681
- * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
682
- * admin on whose behalf the mutation is recorded.
673
+ * Adds a reply to an existing conversation. Supports both contact (customer/lead)
674
+ * and admin replies.
683
675
  *
684
676
  * ### Path Parameters
685
677
  *
@@ -687,78 +679,88 @@ export declare class Conversations extends APIResource {
687
679
  *
688
680
  * ### Request Body
689
681
  *
690
- * | Field | Type | Required | Description |
691
- * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
692
- * | `tagId` | string | Yes | The Featurebase tag ID to attach |
693
- * | `actingAdminId` | string | Yes | The admin performing the mutation. Must be a member of the organization. |
694
- *
695
- * ### Behavior
696
- *
697
- * Featurebase resolves the latest taggable reply/message in the conversation and
698
- * records the tag attachment against that part so audit metadata remains
699
- * deterministic.
700
- *
701
- * ### Response
702
- *
703
- * Returns the affected tag plus attachment metadata such as `targetPartId`,
704
- * `appliedAt`, and `appliedBy`.
705
- *
706
- * ### Example Request
707
- *
708
- * ```json
709
- * {
710
- * "tagId": "67ec1234abcd5678ef901234",
711
- * "actingAdminId": "507f1f77bcf86cd799439011"
712
- * }
713
- * ```
682
+ * The request body varies based on who is sending the reply:
714
683
  *
715
- * ### Version Availability
684
+ * #### Contact Reply (customer/lead)
716
685
  *
717
- * This endpoint is only available in API version 2026-01-01.nova and newer.
686
+ * | Field | Type | Required | Description |
687
+ * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
688
+ * | `type` | string | Yes | Must be "contact" |
689
+ * | `userId` | string | No\* | External user ID from your system |
690
+ * | `id` | string | No\* | Featurebase contact ID (24-character ObjectId) |
691
+ * | `bodyMarkdown` | string | Yes | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
692
+ * | `messageType` | string | Yes | Must be "reply" |
693
+ * | `skipNotifications` | boolean | No | Skip sending notifications (default: false). Useful for bulk imports. |
718
694
  *
719
- * @example
720
- * ```ts
721
- * const attachedConversationTag =
722
- * await client.support.conversations.attachTag('12345', {
723
- * actingAdminId: '507f1f77bcf86cd799439011',
724
- * tagId: '67ec1234abcd5678ef901234',
725
- * });
726
- * ```
727
- */
728
- attachTag(id: string, params: ConversationAttachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
729
- /**
730
- * Removes a workspace tag from a conversation.
695
+ * \*At least one of `userId` or `id` is required.
731
696
  *
732
- * This endpoint requires the `actingAdminId` of the admin on whose behalf the
733
- * mutation is recorded.
697
+ * #### Admin Reply
734
698
  *
735
- * ### Path Parameters
699
+ * | Field | Type | Required | Description |
700
+ * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
701
+ * | `type` | string | Yes | Must be "admin" |
702
+ * | `id` | string | Yes | Featurebase admin ID (24-character ObjectId) |
703
+ * | `bodyMarkdown` | string | Yes | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
704
+ * | `messageType` | string | Yes | "reply" for customer-visible reply, "note" for internal note |
705
+ * | `skipNotifications` | boolean | No | Skip sending notifications (default: false). Useful for bulk imports. |
736
706
  *
737
- * - `id` - The conversation ID (short ID)
738
- * - `tagId` - The Featurebase tag ID to remove
707
+ * ### Response
739
708
  *
740
- * ### Request Body
709
+ * Returns the created conversation part object with a **201 Created** status. The
710
+ * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
711
+ * fields.
741
712
  *
742
- * | Field | Type | Required | Description |
743
- * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
744
- * | `actingAdminId` | string | Yes | The admin performing the mutation. Must be a member of the organization. |
713
+ * ### Example Contact Reply
745
714
  *
746
- * ### Behavior
715
+ * ```json
716
+ * {
717
+ * "type": "contact",
718
+ * "userId": "user_123",
719
+ * "bodyMarkdown": "Thank you for your help!",
720
+ * "messageType": "reply"
721
+ * }
722
+ * ```
747
723
  *
748
- * Featurebase resolves the latest taggable reply/message in the conversation and
749
- * records the tag removal against that part so audit metadata remains
750
- * deterministic.
724
+ * ### Example Admin Reply
751
725
  *
752
- * ### Response
726
+ * ```json
727
+ * {
728
+ * "type": "admin",
729
+ * "id": "507f1f77bcf86cd799439011",
730
+ * "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
731
+ * "messageType": "reply"
732
+ * }
733
+ * ```
753
734
  *
754
- * Returns the affected tag payload with the most relevant attachment metadata
755
- * available for that relationship.
735
+ * ### Example Admin Note (Internal)
756
736
  *
757
- * ### Example Request
737
+ * ```json
738
+ * {
739
+ * "type": "admin",
740
+ * "id": "507f1f77bcf86cd799439011",
741
+ * "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
742
+ * "messageType": "note"
743
+ * }
744
+ * ```
745
+ *
746
+ * ### Example Response
758
747
  *
759
748
  * ```json
760
749
  * {
761
- * "actingAdminId": "507f1f77bcf86cd799439011"
750
+ * "object": "conversation_part",
751
+ * "id": "3",
752
+ * "partType": "user_msg",
753
+ * "bodyHtml": "<p>Thank you for your help!</p>",
754
+ * "bodyMarkdown": "Thank you for your help!",
755
+ * "author": {
756
+ * "type": "customer",
757
+ * "id": "676f0f6765bdaa7d7d760f88",
758
+ * "name": "John Doe",
759
+ * "email": "john@example.com"
760
+ * },
761
+ * "channel": "desktop",
762
+ * "createdAt": "2025-01-15T10:40:00.000Z",
763
+ * "updatedAt": "2025-01-15T10:40:00.000Z"
762
764
  * }
763
765
  * ```
764
766
  *
@@ -768,17 +770,15 @@ export declare class Conversations extends APIResource {
768
770
  *
769
771
  * @example
770
772
  * ```ts
771
- * const attachedConversationTag =
772
- * await client.support.conversations.detachTag(
773
- * '67ec1234abcd5678ef901234',
774
- * {
775
- * id: '12345',
776
- * actingAdminId: '507f1f77bcf86cd799439011',
777
- * },
778
- * );
773
+ * const conversationPart =
774
+ * await client.support.conversations.reply('12345', {
775
+ * bodyMarkdown: 'Thank you for your help!',
776
+ * messageType: 'reply',
777
+ * type: 'contact',
778
+ * });
779
779
  * ```
780
780
  */
781
- detachTag(tagID: string, params: ConversationDetachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
781
+ reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart>;
782
782
  /**
783
783
  * Search conversations with a structured filter AST and an optional full-text
784
784
  * query.
@@ -879,6 +879,16 @@ export declare class Conversations extends APIResource {
879
879
  * fields (`state`, `priority`) are exempt because their negation is naturally
880
880
  * bounded.
881
881
  *
882
+ * ### Inbox visibility
883
+ *
884
+ * An open-state filter uses the same visibility rule as the Featurebase dashboard
885
+ * inbox. Workflow and outbound-message shells are excluded until a customer or
886
+ * lead interacts with them. As a result, `state = "open"` (or an `IN`/`NIN` filter
887
+ * that resolves exclusively to open) returns the conversations shown in the
888
+ * dashboard's open inbox rather than unreplied campaign or automation shells.
889
+ * Searches without an open-only state filter keep their existing organization-wide
890
+ * semantics.
891
+ *
882
892
  * ### Pagination
883
893
  *
884
894
  * Cursor-based, `limit` between 1 and 100 (default 10). Pagination cursors are
@@ -1278,6 +1288,11 @@ export interface ConversationAttributeValue {
1278
1288
  * Allowed values for select and multi-select attributes.
1279
1289
  */
1280
1290
  options?: Array<ConversationAttributesAPI.ConversationAttributeOption>;
1291
+ /**
1292
+ * Whether teammates must set a value before closing a conversation from the Inbox.
1293
+ * Closes via the API, workflows, and Fibi are not blocked.
1294
+ */
1295
+ required?: boolean;
1281
1296
  /**
1282
1297
  * The conversation-specific custom attribute value.
1283
1298
  */
@@ -2198,7 +2213,15 @@ export interface CsatEmailDelivery {
2198
2213
  /**
2199
2214
  * Email delivery status for the CSAT request when applicable
2200
2215
  */
2201
- status: 'pending' | 'sent' | 'failed';
2216
+ status: 'pending' | 'sending' | 'ambiguous' | 'retry_wait' | 'sent' | 'failed';
2217
+ /**
2218
+ * Number of delivery attempts made for this CSAT email
2219
+ */
2220
+ attempts?: number;
2221
+ /**
2222
+ * ISO timestamp when the current delivery attempt was durably claimed
2223
+ */
2224
+ claimedAt?: string;
2202
2225
  /**
2203
2226
  * ISO timestamp when the CSAT email failed
2204
2227
  */
@@ -2207,10 +2230,18 @@ export interface CsatEmailDelivery {
2207
2230
  * Operational failure reason for the CSAT email delivery
2208
2231
  */
2209
2232
  failureReason?: string;
2233
+ /**
2234
+ * Stable provider-correlation key for this CSAT delivery
2235
+ */
2236
+ idempotencyKey?: string;
2210
2237
  /**
2211
2238
  * Email message ID associated with delivery
2212
2239
  */
2213
2240
  messageId?: string;
2241
+ /**
2242
+ * ISO timestamp when a retry-waiting CSAT email may be attempted again
2243
+ */
2244
+ nextAttemptAt?: string;
2214
2245
  /**
2215
2246
  * ISO timestamp when the CSAT email was sent
2216
2247
  */
@@ -2602,24 +2633,6 @@ export declare namespace ConversationSearchResponse {
2602
2633
  }
2603
2634
  }
2604
2635
  }
2605
- export interface ConversationListParams extends CursorPageParams {
2606
- /**
2607
- * Query param: Comma-separated optional expansions. Use
2608
- * `customAttributeDefinitions` to return `customAttributeValues` with names and
2609
- * types alongside ID-keyed `customAttributes`.
2610
- */
2611
- include?: string | Array<string>;
2612
- /**
2613
- * Query param: Filter conversations by one or more tag IDs using a comma-separated
2614
- * list. Conversations must contain all provided tags.
2615
- */
2616
- tagIds?: string | Array<string>;
2617
- /**
2618
- * Header param: API version for this request. Defaults to your organization's
2619
- * configured API version if not specified.
2620
- */
2621
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2622
- }
2623
2636
  export interface ConversationCreateParams {
2624
2637
  /**
2625
2638
  * Body param: The content of the initial message in markdown format. Images
@@ -2657,7 +2670,7 @@ export interface ConversationCreateParams {
2657
2670
  * Header param: API version for this request. Defaults to your organization's
2658
2671
  * configured API version if not specified.
2659
2672
  */
2660
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2673
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2661
2674
  }
2662
2675
  export declare namespace ConversationCreateParams {
2663
2676
  /**
@@ -2716,14 +2729,7 @@ export interface ConversationRetrieveParams {
2716
2729
  * Header param: API version for this request. Defaults to your organization's
2717
2730
  * configured API version if not specified.
2718
2731
  */
2719
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2720
- }
2721
- export interface ConversationDeleteParams {
2722
- /**
2723
- * API version for this request. Defaults to your organization's configured API
2724
- * version if not specified.
2725
- */
2726
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2732
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2727
2733
  }
2728
2734
  export interface ConversationUpdateParams {
2729
2735
  /**
@@ -2770,7 +2776,7 @@ export interface ConversationUpdateParams {
2770
2776
  * Header param: API version for this request. Defaults to your organization's
2771
2777
  * configured API version if not specified.
2772
2778
  */
2773
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2779
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2774
2780
  }
2775
2781
  export declare namespace ConversationUpdateParams {
2776
2782
  /**
@@ -2798,6 +2804,88 @@ export declare namespace ConversationUpdateParams {
2798
2804
  contactIds?: Array<string>;
2799
2805
  }
2800
2806
  }
2807
+ export interface ConversationListParams extends CursorPageParams {
2808
+ /**
2809
+ * Query param: Comma-separated optional expansions. Use
2810
+ * `customAttributeDefinitions` to return `customAttributeValues` with names and
2811
+ * types alongside ID-keyed `customAttributes`.
2812
+ */
2813
+ include?: string | Array<string>;
2814
+ /**
2815
+ * Query param: Filter conversations by one or more tag IDs using a comma-separated
2816
+ * list. Conversations must contain all provided tags.
2817
+ */
2818
+ tagIds?: string | Array<string>;
2819
+ /**
2820
+ * Header param: API version for this request. Defaults to your organization's
2821
+ * configured API version if not specified.
2822
+ */
2823
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2824
+ }
2825
+ export interface ConversationDeleteParams {
2826
+ /**
2827
+ * API version for this request. Defaults to your organization's configured API
2828
+ * version if not specified.
2829
+ */
2830
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2831
+ }
2832
+ export interface ConversationAttachTagParams {
2833
+ /**
2834
+ * Body param: Required admin ID performing this tag attachment. Must be a member
2835
+ * of the organization so the mutation can be attributed to a real admin actor.
2836
+ */
2837
+ actingAdminId: string;
2838
+ /**
2839
+ * Body param: The Featurebase tag ID to attach to the conversation.
2840
+ */
2841
+ tagId: string;
2842
+ /**
2843
+ * Header param: API version for this request. Defaults to your organization's
2844
+ * configured API version if not specified.
2845
+ */
2846
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2847
+ }
2848
+ export interface ConversationDetachTagParams {
2849
+ /**
2850
+ * Path param: Conversation ID (short ID)
2851
+ */
2852
+ id: string;
2853
+ /**
2854
+ * Body param: Required admin ID performing this tag removal. Must be a member of
2855
+ * the organization so the mutation can be attributed to a real admin actor.
2856
+ */
2857
+ actingAdminId: string;
2858
+ /**
2859
+ * Header param: API version for this request. Defaults to your organization's
2860
+ * configured API version if not specified.
2861
+ */
2862
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2863
+ }
2864
+ export interface ConversationRedactParams {
2865
+ /**
2866
+ * Body param: The conversation short ID that contains the part to redact
2867
+ */
2868
+ conversationId: string;
2869
+ /**
2870
+ * Body param: The conversation part short ID to redact
2871
+ */
2872
+ conversationPartId: string;
2873
+ /**
2874
+ * Body param: The type of item to redact. Currently only "conversation_part" is
2875
+ * supported.
2876
+ */
2877
+ type: 'conversation_part';
2878
+ /**
2879
+ * Body param: The admin ID performing this action. If not provided, changes are
2880
+ * attributed to the system bot user.
2881
+ */
2882
+ actingAdminId?: string;
2883
+ /**
2884
+ * Header param: API version for this request. Defaults to your organization's
2885
+ * configured API version if not specified.
2886
+ */
2887
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2888
+ }
2801
2889
  export type ConversationReplyParams = ConversationReplyParams.ContactReplyBody | ConversationReplyParams.AdminReplyBody;
2802
2890
  export declare namespace ConversationReplyParams {
2803
2891
  interface ContactReplyBody {
@@ -2832,7 +2920,7 @@ export declare namespace ConversationReplyParams {
2832
2920
  * Header param: API version for this request. Defaults to your organization's
2833
2921
  * configured API version if not specified.
2834
2922
  */
2835
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2923
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2836
2924
  }
2837
2925
  interface AdminReplyBody {
2838
2926
  /**
@@ -2863,66 +2951,9 @@ export declare namespace ConversationReplyParams {
2863
2951
  * Header param: API version for this request. Defaults to your organization's
2864
2952
  * configured API version if not specified.
2865
2953
  */
2866
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2954
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2867
2955
  }
2868
2956
  }
2869
- export interface ConversationRedactParams {
2870
- /**
2871
- * Body param: The conversation short ID that contains the part to redact
2872
- */
2873
- conversationId: string;
2874
- /**
2875
- * Body param: The conversation part short ID to redact
2876
- */
2877
- conversationPartId: string;
2878
- /**
2879
- * Body param: The type of item to redact. Currently only "conversation_part" is
2880
- * supported.
2881
- */
2882
- type: 'conversation_part';
2883
- /**
2884
- * Body param: The admin ID performing this action. If not provided, changes are
2885
- * attributed to the system bot user.
2886
- */
2887
- actingAdminId?: string;
2888
- /**
2889
- * Header param: API version for this request. Defaults to your organization's
2890
- * configured API version if not specified.
2891
- */
2892
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2893
- }
2894
- export interface ConversationAttachTagParams {
2895
- /**
2896
- * Body param: Required admin ID performing this tag attachment. Must be a member
2897
- * of the organization so the mutation can be attributed to a real admin actor.
2898
- */
2899
- actingAdminId: string;
2900
- /**
2901
- * Body param: The Featurebase tag ID to attach to the conversation.
2902
- */
2903
- tagId: string;
2904
- /**
2905
- * Header param: API version for this request. Defaults to your organization's
2906
- * configured API version if not specified.
2907
- */
2908
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2909
- }
2910
- export interface ConversationDetachTagParams {
2911
- /**
2912
- * Path param: Conversation ID (short ID)
2913
- */
2914
- id: string;
2915
- /**
2916
- * Body param: Required admin ID performing this tag removal. Must be a member of
2917
- * the organization so the mutation can be attributed to a real admin actor.
2918
- */
2919
- actingAdminId: string;
2920
- /**
2921
- * Header param: API version for this request. Defaults to your organization's
2922
- * configured API version if not specified.
2923
- */
2924
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2925
- }
2926
2957
  export interface ConversationSearchParams {
2927
2958
  /**
2928
2959
  * Body param: An opaque cursor for pagination. Use the nextCursor value from a
@@ -2964,10 +2995,10 @@ export interface ConversationSearchParams {
2964
2995
  * Header param: API version for this request. Defaults to your organization's
2965
2996
  * configured API version if not specified.
2966
2997
  */
2967
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
2998
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
2968
2999
  }
2969
3000
  export declare namespace Conversations {
2970
- export { type AttachedConversationTag as AttachedConversationTag, type Conversation as Conversation, type ConversationAttributeValue as ConversationAttributeValue, type ConversationPart as ConversationPart, type ConversationPartAuthor as ConversationPartAuthor, type ConversationParticipant as ConversationParticipant, type ConversationTagApplication as ConversationTagApplication, type ConversationTagMutationActor as ConversationTagMutationActor, type CsatEmailDelivery as CsatEmailDelivery, type CsatRatedAgent as CsatRatedAgent, type CsatSlackDelivery as CsatSlackDelivery, type CsatWorkflowLink as CsatWorkflowLink, type EmailRecipients as EmailRecipients, type MessageSource as MessageSource, type SearchMatchingPartAuthor as SearchMatchingPartAuthor, type SlackMessageDetails as SlackMessageDetails, type ConversationDeleteResponse as ConversationDeleteResponse, type ConversationSearchResponse as ConversationSearchResponse, type ConversationsCursorPage as ConversationsCursorPage, type ConversationListParams as ConversationListParams, type ConversationCreateParams as ConversationCreateParams, type ConversationRetrieveParams as ConversationRetrieveParams, type ConversationDeleteParams as ConversationDeleteParams, type ConversationUpdateParams as ConversationUpdateParams, type ConversationReplyParams as ConversationReplyParams, type ConversationRedactParams as ConversationRedactParams, type ConversationAttachTagParams as ConversationAttachTagParams, type ConversationDetachTagParams as ConversationDetachTagParams, type ConversationSearchParams as ConversationSearchParams, };
3001
+ export { type AttachedConversationTag as AttachedConversationTag, type Conversation as Conversation, type ConversationAttributeValue as ConversationAttributeValue, type ConversationPart as ConversationPart, type ConversationPartAuthor as ConversationPartAuthor, type ConversationParticipant as ConversationParticipant, type ConversationTagApplication as ConversationTagApplication, type ConversationTagMutationActor as ConversationTagMutationActor, type CsatEmailDelivery as CsatEmailDelivery, type CsatRatedAgent as CsatRatedAgent, type CsatSlackDelivery as CsatSlackDelivery, type CsatWorkflowLink as CsatWorkflowLink, type EmailRecipients as EmailRecipients, type MessageSource as MessageSource, type SearchMatchingPartAuthor as SearchMatchingPartAuthor, type SlackMessageDetails as SlackMessageDetails, type ConversationDeleteResponse as ConversationDeleteResponse, type ConversationSearchResponse as ConversationSearchResponse, type ConversationsCursorPage as ConversationsCursorPage, type ConversationCreateParams as ConversationCreateParams, type ConversationRetrieveParams as ConversationRetrieveParams, type ConversationUpdateParams as ConversationUpdateParams, type ConversationListParams as ConversationListParams, type ConversationDeleteParams as ConversationDeleteParams, type ConversationAttachTagParams as ConversationAttachTagParams, type ConversationDetachTagParams as ConversationDetachTagParams, type ConversationRedactParams as ConversationRedactParams, type ConversationReplyParams as ConversationReplyParams, type ConversationSearchParams as ConversationSearchParams, };
2971
3002
  export { Participants as Participants, type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, };
2972
3003
  }
2973
3004
  //# sourceMappingURL=conversations.d.mts.map