featurebase-node 0.14.3 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (362) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/client.d.mts +5 -5
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +5 -5
  5. package/client.d.ts.map +1 -1
  6. package/package.json +1 -1
  7. package/resources/audit-logs.d.mts +3 -3
  8. package/resources/audit-logs.d.mts.map +1 -1
  9. package/resources/audit-logs.d.ts +3 -3
  10. package/resources/audit-logs.d.ts.map +1 -1
  11. package/resources/changelogs/changelogs.d.mts +116 -116
  12. package/resources/changelogs/changelogs.d.mts.map +1 -1
  13. package/resources/changelogs/changelogs.d.ts +116 -116
  14. package/resources/changelogs/changelogs.d.ts.map +1 -1
  15. package/resources/changelogs/changelogs.js +74 -74
  16. package/resources/changelogs/changelogs.js.map +1 -1
  17. package/resources/changelogs/changelogs.mjs +74 -74
  18. package/resources/changelogs/changelogs.mjs.map +1 -1
  19. package/resources/changelogs/index.d.mts +1 -1
  20. package/resources/changelogs/index.d.mts.map +1 -1
  21. package/resources/changelogs/index.d.ts +1 -1
  22. package/resources/changelogs/index.d.ts.map +1 -1
  23. package/resources/changelogs/subscribers.d.mts +3 -3
  24. package/resources/changelogs/subscribers.d.mts.map +1 -1
  25. package/resources/changelogs/subscribers.d.ts +3 -3
  26. package/resources/changelogs/subscribers.d.ts.map +1 -1
  27. package/resources/conversation-attributes.d.mts +17 -17
  28. package/resources/conversation-attributes.d.mts.map +1 -1
  29. package/resources/conversation-attributes.d.ts +17 -17
  30. package/resources/conversation-attributes.d.ts.map +1 -1
  31. package/resources/conversation-attributes.js +19 -19
  32. package/resources/conversation-attributes.js.map +1 -1
  33. package/resources/conversation-attributes.mjs +19 -19
  34. package/resources/conversation-attributes.mjs.map +1 -1
  35. package/resources/feedback/boards.d.mts +19 -19
  36. package/resources/feedback/boards.d.mts.map +1 -1
  37. package/resources/feedback/boards.d.ts +19 -19
  38. package/resources/feedback/boards.d.ts.map +1 -1
  39. package/resources/feedback/boards.js +20 -20
  40. package/resources/feedback/boards.js.map +1 -1
  41. package/resources/feedback/boards.mjs +20 -20
  42. package/resources/feedback/boards.mjs.map +1 -1
  43. package/resources/feedback/comments.d.mts +113 -113
  44. package/resources/feedback/comments.d.mts.map +1 -1
  45. package/resources/feedback/comments.d.ts +113 -113
  46. package/resources/feedback/comments.d.ts.map +1 -1
  47. package/resources/feedback/comments.js +93 -93
  48. package/resources/feedback/comments.js.map +1 -1
  49. package/resources/feedback/comments.mjs +93 -93
  50. package/resources/feedback/comments.mjs.map +1 -1
  51. package/resources/feedback/custom-fields.d.mts +36 -36
  52. package/resources/feedback/custom-fields.d.mts.map +1 -1
  53. package/resources/feedback/custom-fields.d.ts +36 -36
  54. package/resources/feedback/custom-fields.d.ts.map +1 -1
  55. package/resources/feedback/custom-fields.js +36 -36
  56. package/resources/feedback/custom-fields.js.map +1 -1
  57. package/resources/feedback/custom-fields.mjs +36 -36
  58. package/resources/feedback/custom-fields.mjs.map +1 -1
  59. package/resources/feedback/feedback.d.mts +5 -5
  60. package/resources/feedback/feedback.d.mts.map +1 -1
  61. package/resources/feedback/feedback.d.ts +5 -5
  62. package/resources/feedback/feedback.d.ts.map +1 -1
  63. package/resources/feedback/index.d.mts +5 -5
  64. package/resources/feedback/index.d.mts.map +1 -1
  65. package/resources/feedback/index.d.ts +5 -5
  66. package/resources/feedback/index.d.ts.map +1 -1
  67. package/resources/feedback/post-statuses.d.mts +20 -20
  68. package/resources/feedback/post-statuses.d.mts.map +1 -1
  69. package/resources/feedback/post-statuses.d.ts +20 -20
  70. package/resources/feedback/post-statuses.d.ts.map +1 -1
  71. package/resources/feedback/post-statuses.js +23 -23
  72. package/resources/feedback/post-statuses.js.map +1 -1
  73. package/resources/feedback/post-statuses.mjs +23 -23
  74. package/resources/feedback/post-statuses.mjs.map +1 -1
  75. package/resources/feedback/posts/index.d.mts +1 -1
  76. package/resources/feedback/posts/index.d.mts.map +1 -1
  77. package/resources/feedback/posts/index.d.ts +1 -1
  78. package/resources/feedback/posts/index.d.ts.map +1 -1
  79. package/resources/feedback/posts/posts.d.mts +132 -132
  80. package/resources/feedback/posts/posts.d.mts.map +1 -1
  81. package/resources/feedback/posts/posts.d.ts +132 -132
  82. package/resources/feedback/posts/posts.d.ts.map +1 -1
  83. package/resources/feedback/posts/posts.js +107 -107
  84. package/resources/feedback/posts/posts.js.map +1 -1
  85. package/resources/feedback/posts/posts.mjs +107 -107
  86. package/resources/feedback/posts/posts.mjs.map +1 -1
  87. package/resources/feedback/posts/voters.d.mts +3 -3
  88. package/resources/feedback/posts/voters.d.mts.map +1 -1
  89. package/resources/feedback/posts/voters.d.ts +3 -3
  90. package/resources/feedback/posts/voters.d.ts.map +1 -1
  91. package/resources/help-center/articles.d.mts +213 -97
  92. package/resources/help-center/articles.d.mts.map +1 -1
  93. package/resources/help-center/articles.d.ts +213 -97
  94. package/resources/help-center/articles.d.ts.map +1 -1
  95. package/resources/help-center/articles.js +73 -73
  96. package/resources/help-center/articles.js.map +1 -1
  97. package/resources/help-center/articles.mjs +73 -73
  98. package/resources/help-center/articles.mjs.map +1 -1
  99. package/resources/help-center/collections.d.mts +158 -71
  100. package/resources/help-center/collections.d.mts.map +1 -1
  101. package/resources/help-center/collections.d.ts +158 -71
  102. package/resources/help-center/collections.d.ts.map +1 -1
  103. package/resources/help-center/collections.js +65 -65
  104. package/resources/help-center/collections.js.map +1 -1
  105. package/resources/help-center/collections.mjs +65 -65
  106. package/resources/help-center/collections.mjs.map +1 -1
  107. package/resources/help-center/help-center.d.mts +4 -4
  108. package/resources/help-center/help-center.d.mts.map +1 -1
  109. package/resources/help-center/help-center.d.ts +4 -4
  110. package/resources/help-center/help-center.d.ts.map +1 -1
  111. package/resources/help-center/help-centers.d.mts +77 -48
  112. package/resources/help-center/help-centers.d.mts.map +1 -1
  113. package/resources/help-center/help-centers.d.ts +77 -48
  114. package/resources/help-center/help-centers.d.ts.map +1 -1
  115. package/resources/help-center/help-centers.js +43 -43
  116. package/resources/help-center/help-centers.js.map +1 -1
  117. package/resources/help-center/help-centers.mjs +43 -43
  118. package/resources/help-center/help-centers.mjs.map +1 -1
  119. package/resources/help-center/index.d.mts +4 -4
  120. package/resources/help-center/index.d.mts.map +1 -1
  121. package/resources/help-center/index.d.ts +4 -4
  122. package/resources/help-center/index.d.ts.map +1 -1
  123. package/resources/help-center/redirect-rules.d.mts +124 -124
  124. package/resources/help-center/redirect-rules.d.mts.map +1 -1
  125. package/resources/help-center/redirect-rules.d.ts +124 -124
  126. package/resources/help-center/redirect-rules.d.ts.map +1 -1
  127. package/resources/help-center/redirect-rules.js +112 -112
  128. package/resources/help-center/redirect-rules.js.map +1 -1
  129. package/resources/help-center/redirect-rules.mjs +112 -112
  130. package/resources/help-center/redirect-rules.mjs.map +1 -1
  131. package/resources/index.d.mts +5 -5
  132. package/resources/index.d.mts.map +1 -1
  133. package/resources/index.d.ts +5 -5
  134. package/resources/index.d.ts.map +1 -1
  135. package/resources/organization/admins.d.mts +26 -26
  136. package/resources/organization/admins.d.mts.map +1 -1
  137. package/resources/organization/admins.d.ts +26 -26
  138. package/resources/organization/admins.d.ts.map +1 -1
  139. package/resources/organization/admins.js +25 -25
  140. package/resources/organization/admins.js.map +1 -1
  141. package/resources/organization/admins.mjs +25 -25
  142. package/resources/organization/admins.mjs.map +1 -1
  143. package/resources/organization/brands.d.mts +52 -52
  144. package/resources/organization/brands.d.mts.map +1 -1
  145. package/resources/organization/brands.d.ts +52 -52
  146. package/resources/organization/brands.d.ts.map +1 -1
  147. package/resources/organization/brands.js +54 -54
  148. package/resources/organization/brands.js.map +1 -1
  149. package/resources/organization/brands.mjs +54 -54
  150. package/resources/organization/brands.mjs.map +1 -1
  151. package/resources/organization/index.d.mts +3 -3
  152. package/resources/organization/index.d.mts.map +1 -1
  153. package/resources/organization/index.d.ts +3 -3
  154. package/resources/organization/index.d.ts.map +1 -1
  155. package/resources/organization/organization.d.mts +3 -3
  156. package/resources/organization/organization.d.mts.map +1 -1
  157. package/resources/organization/organization.d.ts +3 -3
  158. package/resources/organization/organization.d.ts.map +1 -1
  159. package/resources/organization/teams.d.mts +47 -47
  160. package/resources/organization/teams.d.mts.map +1 -1
  161. package/resources/organization/teams.d.ts +47 -47
  162. package/resources/organization/teams.d.ts.map +1 -1
  163. package/resources/organization/teams.js +44 -44
  164. package/resources/organization/teams.js.map +1 -1
  165. package/resources/organization/teams.mjs +44 -44
  166. package/resources/organization/teams.mjs.map +1 -1
  167. package/resources/reports.d.mts +249 -215
  168. package/resources/reports.d.mts.map +1 -1
  169. package/resources/reports.d.ts +249 -215
  170. package/resources/reports.d.ts.map +1 -1
  171. package/resources/reports.js +99 -99
  172. package/resources/reports.js.map +1 -1
  173. package/resources/reports.mjs +99 -99
  174. package/resources/reports.mjs.map +1 -1
  175. package/resources/support/conversation-tags.d.mts +43 -43
  176. package/resources/support/conversation-tags.d.mts.map +1 -1
  177. package/resources/support/conversation-tags.d.ts +43 -43
  178. package/resources/support/conversation-tags.d.ts.map +1 -1
  179. package/resources/support/conversation-tags.js +32 -32
  180. package/resources/support/conversation-tags.js.map +1 -1
  181. package/resources/support/conversation-tags.mjs +32 -32
  182. package/resources/support/conversation-tags.mjs.map +1 -1
  183. package/resources/support/conversations/conversations.d.mts +337 -327
  184. package/resources/support/conversations/conversations.d.mts.map +1 -1
  185. package/resources/support/conversations/conversations.d.ts +337 -327
  186. package/resources/support/conversations/conversations.d.ts.map +1 -1
  187. package/resources/support/conversations/conversations.js +293 -283
  188. package/resources/support/conversations/conversations.js.map +1 -1
  189. package/resources/support/conversations/conversations.mjs +293 -283
  190. package/resources/support/conversations/conversations.mjs.map +1 -1
  191. package/resources/support/conversations/index.d.mts +1 -1
  192. package/resources/support/conversations/index.d.mts.map +1 -1
  193. package/resources/support/conversations/index.d.ts +1 -1
  194. package/resources/support/conversations/index.d.ts.map +1 -1
  195. package/resources/support/conversations/participants.d.mts +2 -2
  196. package/resources/support/conversations/participants.d.mts.map +1 -1
  197. package/resources/support/conversations/participants.d.ts +2 -2
  198. package/resources/support/conversations/participants.d.ts.map +1 -1
  199. package/resources/support/index.d.mts +3 -3
  200. package/resources/support/index.d.mts.map +1 -1
  201. package/resources/support/index.d.ts +3 -3
  202. package/resources/support/index.d.ts.map +1 -1
  203. package/resources/support/support.d.mts +3 -3
  204. package/resources/support/support.d.mts.map +1 -1
  205. package/resources/support/support.d.ts +3 -3
  206. package/resources/support/support.d.ts.map +1 -1
  207. package/resources/support/tickets/categories.d.mts +20 -20
  208. package/resources/support/tickets/categories.d.mts.map +1 -1
  209. package/resources/support/tickets/categories.d.ts +20 -20
  210. package/resources/support/tickets/categories.d.ts.map +1 -1
  211. package/resources/support/tickets/categories.js +25 -25
  212. package/resources/support/tickets/categories.js.map +1 -1
  213. package/resources/support/tickets/categories.mjs +25 -25
  214. package/resources/support/tickets/categories.mjs.map +1 -1
  215. package/resources/support/tickets/custom-fields.d.mts +22 -22
  216. package/resources/support/tickets/custom-fields.d.mts.map +1 -1
  217. package/resources/support/tickets/custom-fields.d.ts +22 -22
  218. package/resources/support/tickets/custom-fields.d.ts.map +1 -1
  219. package/resources/support/tickets/custom-fields.js +19 -19
  220. package/resources/support/tickets/custom-fields.js.map +1 -1
  221. package/resources/support/tickets/custom-fields.mjs +19 -19
  222. package/resources/support/tickets/custom-fields.mjs.map +1 -1
  223. package/resources/support/tickets/index.d.mts +4 -4
  224. package/resources/support/tickets/index.d.mts.map +1 -1
  225. package/resources/support/tickets/index.d.ts +4 -4
  226. package/resources/support/tickets/index.d.ts.map +1 -1
  227. package/resources/support/tickets/statuses.d.mts +19 -19
  228. package/resources/support/tickets/statuses.d.mts.map +1 -1
  229. package/resources/support/tickets/statuses.d.ts +19 -19
  230. package/resources/support/tickets/statuses.d.ts.map +1 -1
  231. package/resources/support/tickets/statuses.js +21 -21
  232. package/resources/support/tickets/statuses.js.map +1 -1
  233. package/resources/support/tickets/statuses.mjs +21 -21
  234. package/resources/support/tickets/statuses.mjs.map +1 -1
  235. package/resources/support/tickets/tickets.d.mts +75 -75
  236. package/resources/support/tickets/tickets.d.mts.map +1 -1
  237. package/resources/support/tickets/tickets.d.ts +75 -75
  238. package/resources/support/tickets/tickets.d.ts.map +1 -1
  239. package/resources/support/tickets/tickets.js +44 -44
  240. package/resources/support/tickets/tickets.js.map +1 -1
  241. package/resources/support/tickets/tickets.mjs +44 -44
  242. package/resources/support/tickets/tickets.mjs.map +1 -1
  243. package/resources/surveys.d.mts +43 -43
  244. package/resources/surveys.d.mts.map +1 -1
  245. package/resources/surveys.d.ts +43 -43
  246. package/resources/surveys.d.ts.map +1 -1
  247. package/resources/surveys.js +44 -44
  248. package/resources/surveys.js.map +1 -1
  249. package/resources/surveys.mjs +44 -44
  250. package/resources/surveys.mjs.map +1 -1
  251. package/resources/users/companies/companies.d.mts +121 -130
  252. package/resources/users/companies/companies.d.mts.map +1 -1
  253. package/resources/users/companies/companies.d.ts +121 -130
  254. package/resources/users/companies/companies.d.ts.map +1 -1
  255. package/resources/users/companies/companies.js +125 -125
  256. package/resources/users/companies/companies.js.map +1 -1
  257. package/resources/users/companies/companies.mjs +125 -125
  258. package/resources/users/companies/companies.mjs.map +1 -1
  259. package/resources/users/companies/contacts.d.mts +3 -3
  260. package/resources/users/companies/contacts.d.mts.map +1 -1
  261. package/resources/users/companies/contacts.d.ts +3 -3
  262. package/resources/users/companies/contacts.d.ts.map +1 -1
  263. package/resources/users/companies/index.d.mts +1 -1
  264. package/resources/users/companies/index.d.mts.map +1 -1
  265. package/resources/users/companies/index.d.ts +1 -1
  266. package/resources/users/companies/index.d.ts.map +1 -1
  267. package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
  268. package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
  269. package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
  270. package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
  271. package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
  272. package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
  273. package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
  274. package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
  275. package/resources/users/contacts/contacts.d.mts +249 -235
  276. package/resources/users/contacts/contacts.d.mts.map +1 -1
  277. package/resources/users/contacts/contacts.d.ts +249 -235
  278. package/resources/users/contacts/contacts.d.ts.map +1 -1
  279. package/resources/users/contacts/contacts.js +211 -184
  280. package/resources/users/contacts/contacts.js.map +1 -1
  281. package/resources/users/contacts/contacts.mjs +211 -184
  282. package/resources/users/contacts/contacts.mjs.map +1 -1
  283. package/resources/users/contacts/email-preferences.d.mts +2 -2
  284. package/resources/users/contacts/email-preferences.d.mts.map +1 -1
  285. package/resources/users/contacts/email-preferences.d.ts +2 -2
  286. package/resources/users/contacts/email-preferences.d.ts.map +1 -1
  287. package/resources/users/contacts/index.d.mts +1 -1
  288. package/resources/users/contacts/index.d.mts.map +1 -1
  289. package/resources/users/contacts/index.d.ts +1 -1
  290. package/resources/users/contacts/index.d.ts.map +1 -1
  291. package/resources/users/index.d.mts +2 -2
  292. package/resources/users/index.d.mts.map +1 -1
  293. package/resources/users/index.d.ts +2 -2
  294. package/resources/users/index.d.ts.map +1 -1
  295. package/resources/users/users.d.mts +2 -2
  296. package/resources/users/users.d.mts.map +1 -1
  297. package/resources/users/users.d.ts +2 -2
  298. package/resources/users/users.d.ts.map +1 -1
  299. package/resources/webhooks.d.mts +83 -83
  300. package/resources/webhooks.d.mts.map +1 -1
  301. package/resources/webhooks.d.ts +83 -83
  302. package/resources/webhooks.d.ts.map +1 -1
  303. package/resources/webhooks.js +77 -77
  304. package/resources/webhooks.js.map +1 -1
  305. package/resources/webhooks.mjs +77 -77
  306. package/resources/webhooks.mjs.map +1 -1
  307. package/src/client.ts +6 -6
  308. package/src/resources/audit-logs.ts +7 -1
  309. package/src/resources/changelogs/changelogs.ts +320 -175
  310. package/src/resources/changelogs/index.ts +1 -1
  311. package/src/resources/changelogs/subscribers.ts +31 -2
  312. package/src/resources/conversation-attributes.ts +34 -34
  313. package/src/resources/feedback/boards.ts +30 -30
  314. package/src/resources/feedback/comments.ts +137 -137
  315. package/src/resources/feedback/custom-fields.ts +46 -46
  316. package/src/resources/feedback/feedback.ts +6 -6
  317. package/src/resources/feedback/index.ts +6 -6
  318. package/src/resources/feedback/post-statuses.ts +33 -33
  319. package/src/resources/feedback/posts/index.ts +2 -2
  320. package/src/resources/feedback/posts/posts.ts +176 -176
  321. package/src/resources/feedback/posts/voters.ts +3 -3
  322. package/src/resources/help-center/articles.ts +631 -109
  323. package/src/resources/help-center/collections.ts +349 -88
  324. package/src/resources/help-center/help-center.ts +5 -5
  325. package/src/resources/help-center/help-centers.ts +202 -57
  326. package/src/resources/help-center/index.ts +5 -5
  327. package/src/resources/help-center/redirect-rules.ts +294 -178
  328. package/src/resources/index.ts +6 -6
  329. package/src/resources/organization/admins.ts +36 -36
  330. package/src/resources/organization/brands.ts +68 -68
  331. package/src/resources/organization/index.ts +3 -3
  332. package/src/resources/organization/organization.ts +3 -3
  333. package/src/resources/organization/teams.ts +54 -54
  334. package/src/resources/reports.ts +311 -262
  335. package/src/resources/support/conversation-tags.ts +62 -62
  336. package/src/resources/support/conversations/conversations.ts +429 -419
  337. package/src/resources/support/conversations/index.ts +4 -4
  338. package/src/resources/support/conversations/participants.ts +2 -2
  339. package/src/resources/support/index.ts +7 -7
  340. package/src/resources/support/support.ts +7 -7
  341. package/src/resources/support/tickets/categories.ts +35 -35
  342. package/src/resources/support/tickets/custom-fields.ts +29 -29
  343. package/src/resources/support/tickets/index.ts +4 -4
  344. package/src/resources/support/tickets/statuses.ts +31 -31
  345. package/src/resources/support/tickets/tickets.ts +101 -101
  346. package/src/resources/surveys.ts +60 -60
  347. package/src/resources/users/companies/companies.ts +158 -172
  348. package/src/resources/users/companies/contacts.ts +3 -3
  349. package/src/resources/users/companies/index.ts +2 -2
  350. package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
  351. package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
  352. package/src/resources/users/contacts/contacts.ts +284 -280
  353. package/src/resources/users/contacts/email-preferences.ts +2 -2
  354. package/src/resources/users/contacts/index.ts +3 -3
  355. package/src/resources/users/index.ts +5 -5
  356. package/src/resources/users/users.ts +5 -5
  357. package/src/resources/webhooks.ts +106 -100
  358. package/src/version.ts +1 -1
  359. package/version.d.mts +1 -1
  360. package/version.d.ts +1 -1
  361. package/version.js +1 -1
  362. package/version.mjs +1 -1
@@ -11,22 +11,24 @@ import { path } from '../../internal/utils/path';
11
11
  */
12
12
  export class ConversationTags extends APIResource {
13
13
  /**
14
- * Returns the live conversation tags available in the workspace tag catalog. These
15
- * are the canonical tags that power conversation payloads, filters, and tag
16
- * mutation endpoints.
14
+ * Returns a single conversation tag by its Featurebase tag ID. Archived tags can
15
+ * still be retrieved directly by ID, while permanently deleted tags return `404`.
17
16
  *
18
17
  * @example
19
18
  * ```ts
20
- * const conversationTags =
21
- * await client.support.conversationTags.list();
19
+ * const conversationTag =
20
+ * await client.support.conversationTags.retrieve(
21
+ * '67ec1234abcd5678ef901234',
22
+ * );
22
23
  * ```
23
24
  */
24
- list(
25
- params: ConversationTagListParams | null | undefined = {},
25
+ retrieve(
26
+ id: string,
27
+ params: ConversationTagRetrieveParams | null | undefined = {},
26
28
  options?: RequestOptions,
27
- ): APIPromise<ConversationTagListResponse> {
29
+ ): APIPromise<ConversationTag> {
28
30
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
29
- return this._client.get('/v2/tags', {
31
+ return this._client.get(path`/v2/tags/${id}`, {
30
32
  ...options,
31
33
  headers: buildHeaders([
32
34
  {
@@ -40,24 +42,22 @@ export class ConversationTags extends APIResource {
40
42
  }
41
43
 
42
44
  /**
43
- * Creates a new workspace conversation tag when only `name` is provided. If `id`
44
- * is also provided, the existing tag is renamed instead.
45
+ * Returns the live conversation tags available in the workspace tag catalog. These
46
+ * are the canonical tags that power conversation payloads, filters, and tag
47
+ * mutation endpoints.
45
48
  *
46
49
  * @example
47
50
  * ```ts
48
- * const conversationTag =
49
- * await client.support.conversationTags.createOrRename({
50
- * name: 'Churn',
51
- * });
51
+ * const conversationTags =
52
+ * await client.support.conversationTags.list();
52
53
  * ```
53
54
  */
54
- createOrRename(
55
- params: ConversationTagCreateOrRenameParams,
55
+ list(
56
+ params: ConversationTagListParams | null | undefined = {},
56
57
  options?: RequestOptions,
57
- ): APIPromise<ConversationTag> {
58
- const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
59
- return this._client.post('/v2/tags', {
60
- body,
58
+ ): APIPromise<ConversationTagListResponse> {
59
+ const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
60
+ return this._client.get('/v2/tags', {
61
61
  ...options,
62
62
  headers: buildHeaders([
63
63
  {
@@ -71,24 +71,26 @@ export class ConversationTags extends APIResource {
71
71
  }
72
72
 
73
73
  /**
74
- * Returns a single conversation tag by its Featurebase tag ID. Archived tags can
75
- * still be retrieved directly by ID, while permanently deleted tags return `404`.
74
+ * Deletes a conversation tag from the workspace catalog and removes it from
75
+ * aggregate conversation tag state. Archived and historical part applications
76
+ * remain part of the audit trail where applicable.
76
77
  *
77
78
  * @example
78
79
  * ```ts
79
80
  * const conversationTag =
80
- * await client.support.conversationTags.retrieve(
81
+ * await client.support.conversationTags.delete(
81
82
  * '67ec1234abcd5678ef901234',
82
83
  * );
83
84
  * ```
84
85
  */
85
- retrieve(
86
+ delete(
86
87
  id: string,
87
- params: ConversationTagRetrieveParams | null | undefined = {},
88
+ params: ConversationTagDeleteParams | null | undefined = {},
88
89
  options?: RequestOptions,
89
- ): APIPromise<ConversationTag> {
90
- const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
91
- return this._client.get(path`/v2/tags/${id}`, {
90
+ ): APIPromise<ConversationTagDeleteResponse> {
91
+ const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
92
+ return this._client.delete(path`/v2/tags/${id}`, {
93
+ body,
92
94
  ...options,
93
95
  headers: buildHeaders([
94
96
  {
@@ -102,25 +104,23 @@ export class ConversationTags extends APIResource {
102
104
  }
103
105
 
104
106
  /**
105
- * Deletes a conversation tag from the workspace catalog and removes it from
106
- * aggregate conversation tag state. Archived and historical part applications
107
- * remain part of the audit trail where applicable.
107
+ * Creates a new workspace conversation tag when only `name` is provided. If `id`
108
+ * is also provided, the existing tag is renamed instead.
108
109
  *
109
110
  * @example
110
111
  * ```ts
111
112
  * const conversationTag =
112
- * await client.support.conversationTags.delete(
113
- * '67ec1234abcd5678ef901234',
114
- * );
113
+ * await client.support.conversationTags.createOrRename({
114
+ * name: 'Churn',
115
+ * });
115
116
  * ```
116
117
  */
117
- delete(
118
- id: string,
119
- params: ConversationTagDeleteParams | null | undefined = {},
118
+ createOrRename(
119
+ params: ConversationTagCreateOrRenameParams,
120
120
  options?: RequestOptions,
121
- ): APIPromise<ConversationTagDeleteResponse> {
122
- const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
123
- return this._client.delete(path`/v2/tags/${id}`, {
121
+ ): APIPromise<ConversationTag> {
122
+ const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
123
+ return this._client.post('/v2/tags', {
124
124
  body,
125
125
  ...options,
126
126
  headers: buildHeaders([
@@ -186,26 +186,23 @@ export interface ConversationTagDeleteResponse {
186
186
  object: 'tag';
187
187
  }
188
188
 
189
- export interface ConversationTagListParams {
189
+ export interface ConversationTagRetrieveParams {
190
190
  /**
191
191
  * API version for this request. Defaults to your organization's configured API
192
192
  * version if not specified.
193
193
  */
194
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
194
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
195
195
  }
196
196
 
197
- export interface ConversationTagCreateOrRenameParams {
198
- /**
199
- * Body param: Tag name
200
- */
201
- name: string;
202
-
197
+ export interface ConversationTagListParams {
203
198
  /**
204
- * Body param: Optional existing tag ID. Provide this to rename an existing tag
205
- * instead of creating a new one.
199
+ * API version for this request. Defaults to your organization's configured API
200
+ * version if not specified.
206
201
  */
207
- id?: string;
202
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
203
+ }
208
204
 
205
+ export interface ConversationTagDeleteParams {
209
206
  /**
210
207
  * Body param: Optional admin ID for actor attribution and permission checks.
211
208
  */
@@ -215,18 +212,21 @@ export interface ConversationTagCreateOrRenameParams {
215
212
  * Header param: API version for this request. Defaults to your organization's
216
213
  * configured API version if not specified.
217
214
  */
218
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
215
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
219
216
  }
220
217
 
221
- export interface ConversationTagRetrieveParams {
218
+ export interface ConversationTagCreateOrRenameParams {
222
219
  /**
223
- * API version for this request. Defaults to your organization's configured API
224
- * version if not specified.
220
+ * Body param: Tag name
225
221
  */
226
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
227
- }
222
+ name: string;
223
+
224
+ /**
225
+ * Body param: Optional existing tag ID. Provide this to rename an existing tag
226
+ * instead of creating a new one.
227
+ */
228
+ id?: string;
228
229
 
229
- export interface ConversationTagDeleteParams {
230
230
  /**
231
231
  * Body param: Optional admin ID for actor attribution and permission checks.
232
232
  */
@@ -236,7 +236,7 @@ export interface ConversationTagDeleteParams {
236
236
  * Header param: API version for this request. Defaults to your organization's
237
237
  * configured API version if not specified.
238
238
  */
239
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
239
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
240
240
  }
241
241
 
242
242
  export declare namespace ConversationTags {
@@ -244,9 +244,9 @@ export declare namespace ConversationTags {
244
244
  type ConversationTag as ConversationTag,
245
245
  type ConversationTagListResponse as ConversationTagListResponse,
246
246
  type ConversationTagDeleteResponse as ConversationTagDeleteResponse,
247
- type ConversationTagListParams as ConversationTagListParams,
248
- type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams,
249
247
  type ConversationTagRetrieveParams as ConversationTagRetrieveParams,
248
+ type ConversationTagListParams as ConversationTagListParams,
250
249
  type ConversationTagDeleteParams as ConversationTagDeleteParams,
250
+ type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams,
251
251
  };
252
252
  }