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
@@ -7,99 +7,6 @@ import { path } from "../../internal/utils/path.mjs";
7
7
  * Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.
8
8
  */
9
9
  export class Comments extends APIResource {
10
- /**
11
- * Returns comments for your organization.
12
- *
13
- * Comments are threaded discussions. Each comment can have:
14
- *
15
- * - Author information
16
- * - Voting (upvotes/downvotes)
17
- * - Privacy settings (public/private)
18
- * - Moderation status
19
- * - Parent comment reference for threading
20
- *
21
- * ### Filtering
22
- *
23
- * Optionally filter by:
24
- *
25
- * - `postId` - Get comments for a specific post
26
- * - `changelogId` - Get comments for a specific changelog
27
- *
28
- * If no filter is provided, returns all comments across the organization.
29
- *
30
- * ### Pagination
31
- *
32
- * This endpoint uses **cursor-based pagination**:
33
- *
34
- * - `limit` - Number of comments to return (1-100, default 10)
35
- * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
36
- *
37
- * **Example:** To paginate through results:
38
- *
39
- * 1. First request: `GET /v2/comments?postId={id}&limit=10`
40
- * 2. If `nextCursor` is not null, use it for the next page
41
- * 3. Next request: `GET /v2/comments?postId={id}&limit=10&cursor={nextCursor}`
42
- *
43
- * ### Response Format
44
- *
45
- * Returns a list object with:
46
- *
47
- * - `object` - Always "list"
48
- * - `data` - Array of comment objects (flat structure with `parentCommentId` for
49
- * threading)
50
- * - `nextCursor` - Cursor for the next page (null if no more results)
51
- *
52
- * ### Comment Structure
53
- *
54
- * Each comment includes:
55
- *
56
- * - `id` - Unique comment identifier
57
- * - `postId` / `changelogId` - Reference to the parent content
58
- * - `parentCommentId` - Reference to parent comment (null for root comments)
59
- * - `content` - Comment content in HTML format
60
- * - `author` - Author information (id, name, profilePicture, type)
61
- * - `upvotes` / `downvotes` / `score` - Voting metrics
62
- * - `isPrivate` - Whether comment is only visible to admins
63
- * - `inReview` - Whether comment is pending moderation
64
- * - `created` / `updated` - Unix timestamps
65
- *
66
- * ### Additional Filters
67
- *
68
- * - `privacy` - Filter by privacy: "public", "private", or "all"
69
- * - `inReview` - Filter by moderation status (true/false)
70
- *
71
- * ### Sorting
72
- *
73
- * Use `sortBy` to sort results:
74
- *
75
- * - `best` - Sort by confidence score (default, like Reddit)
76
- * - `top` - Sort by net score (upvotes - downvotes)
77
- * - `new` - Sort by creation date, newest first
78
- * - `old` - Sort by creation date, oldest first
79
- *
80
- * @example
81
- * ```ts
82
- * // Automatically fetches more pages as needed.
83
- * for await (const comment of client.feedback.comments.list()) {
84
- * // ...
85
- * }
86
- * ```
87
- */
88
- list(params = {}, options) {
89
- const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
90
- return this._client.getAPIList('/v2/comments', (CursorPage), {
91
- query,
92
- ...options,
93
- headers: buildHeaders([
94
- {
95
- ...(featurebaseVersion?.toString() != null ?
96
- { 'Featurebase-Version': featurebaseVersion?.toString() }
97
- : undefined),
98
- },
99
- options?.headers,
100
- ]),
101
- });
102
- }
103
10
  /**
104
11
  * Creates a new comment or reply to an existing comment.
105
12
  *
@@ -280,6 +187,99 @@ export class Comments extends APIResource {
280
187
  ]),
281
188
  });
282
189
  }
190
+ /**
191
+ * Returns comments for your organization.
192
+ *
193
+ * Comments are threaded discussions. Each comment can have:
194
+ *
195
+ * - Author information
196
+ * - Voting (upvotes/downvotes)
197
+ * - Privacy settings (public/private)
198
+ * - Moderation status
199
+ * - Parent comment reference for threading
200
+ *
201
+ * ### Filtering
202
+ *
203
+ * Optionally filter by:
204
+ *
205
+ * - `postId` - Get comments for a specific post
206
+ * - `changelogId` - Get comments for a specific changelog
207
+ *
208
+ * If no filter is provided, returns all comments across the organization.
209
+ *
210
+ * ### Pagination
211
+ *
212
+ * This endpoint uses **cursor-based pagination**:
213
+ *
214
+ * - `limit` - Number of comments to return (1-100, default 10)
215
+ * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
216
+ *
217
+ * **Example:** To paginate through results:
218
+ *
219
+ * 1. First request: `GET /v2/comments?postId={id}&limit=10`
220
+ * 2. If `nextCursor` is not null, use it for the next page
221
+ * 3. Next request: `GET /v2/comments?postId={id}&limit=10&cursor={nextCursor}`
222
+ *
223
+ * ### Response Format
224
+ *
225
+ * Returns a list object with:
226
+ *
227
+ * - `object` - Always "list"
228
+ * - `data` - Array of comment objects (flat structure with `parentCommentId` for
229
+ * threading)
230
+ * - `nextCursor` - Cursor for the next page (null if no more results)
231
+ *
232
+ * ### Comment Structure
233
+ *
234
+ * Each comment includes:
235
+ *
236
+ * - `id` - Unique comment identifier
237
+ * - `postId` / `changelogId` - Reference to the parent content
238
+ * - `parentCommentId` - Reference to parent comment (null for root comments)
239
+ * - `content` - Comment content in HTML format
240
+ * - `author` - Author information (id, name, profilePicture, type)
241
+ * - `upvotes` / `downvotes` / `score` - Voting metrics
242
+ * - `isPrivate` - Whether comment is only visible to admins
243
+ * - `inReview` - Whether comment is pending moderation
244
+ * - `created` / `updated` - Unix timestamps
245
+ *
246
+ * ### Additional Filters
247
+ *
248
+ * - `privacy` - Filter by privacy: "public", "private", or "all"
249
+ * - `inReview` - Filter by moderation status (true/false)
250
+ *
251
+ * ### Sorting
252
+ *
253
+ * Use `sortBy` to sort results:
254
+ *
255
+ * - `best` - Sort by confidence score (default, like Reddit)
256
+ * - `top` - Sort by net score (upvotes - downvotes)
257
+ * - `new` - Sort by creation date, newest first
258
+ * - `old` - Sort by creation date, oldest first
259
+ *
260
+ * @example
261
+ * ```ts
262
+ * // Automatically fetches more pages as needed.
263
+ * for await (const comment of client.feedback.comments.list()) {
264
+ * // ...
265
+ * }
266
+ * ```
267
+ */
268
+ list(params = {}, options) {
269
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
270
+ return this._client.getAPIList('/v2/comments', (CursorPage), {
271
+ query,
272
+ ...options,
273
+ headers: buildHeaders([
274
+ {
275
+ ...(featurebaseVersion?.toString() != null ?
276
+ { 'Featurebase-Version': featurebaseVersion?.toString() }
277
+ : undefined),
278
+ },
279
+ options?.headers,
280
+ ]),
281
+ });
282
+ }
283
283
  /**
284
284
  * Deletes a comment by its unique identifier.
285
285
  *
@@ -1 +1 @@
1
- {"version":3,"file":"comments.mjs","sourceRoot":"","sources":["../../src/resources/feedback/comments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6EG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAmB,CAAA,EAAE;YAClE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,OAAO,CACL,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CAAC,MAA4B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACxC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgJG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC9C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"comments.mjs","sourceRoot":"","sources":["../../src/resources/feedback/comments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6EG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAmB,CAAA,EAAE;YAClE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,OAAO,CACL,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CAAC,MAA4B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACxC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgJG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC9C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -5,6 +5,37 @@ import { RequestOptions } from "../../internal/request-options.mjs";
5
5
  * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
6
6
  */
7
7
  export declare class CustomFields extends APIResource {
8
+ /**
9
+ * Retrieves a single custom field by its unique identifier.
10
+ *
11
+ * Returns the custom field object if found in your organization.
12
+ *
13
+ * ### Response
14
+ *
15
+ * Returns a custom field object with:
16
+ *
17
+ * - `id` - Unique field identifier
18
+ * - `label` - Field label displayed to users
19
+ * - `type` - Field type (text, number, select, multi-select, checkbox, date)
20
+ * - `required` - Whether the field is required
21
+ * - `placeholder` - Placeholder text (for text/number fields)
22
+ * - `public` - Whether the field value is publicly visible
23
+ * - `internal` - Whether the field is for internal use only
24
+ * - `options` - Array of options (for select/multi-select fields)
25
+ *
26
+ * ### Errors
27
+ *
28
+ * - `404` - Custom field not found in your organization
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const customField =
33
+ * await client.feedback.customFields.retrieve(
34
+ * '65d26304b2e65b1e1278170c',
35
+ * );
36
+ * ```
37
+ */
38
+ retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
8
39
  /**
9
40
  * Returns all custom fields configured in your organization.
10
41
  *
@@ -48,37 +79,6 @@ export declare class CustomFields extends APIResource {
48
79
  * ```
49
80
  */
50
81
  list(params?: CustomFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomFieldList>;
51
- /**
52
- * Retrieves a single custom field by its unique identifier.
53
- *
54
- * Returns the custom field object if found in your organization.
55
- *
56
- * ### Response
57
- *
58
- * Returns a custom field object with:
59
- *
60
- * - `id` - Unique field identifier
61
- * - `label` - Field label displayed to users
62
- * - `type` - Field type (text, number, select, multi-select, checkbox, date)
63
- * - `required` - Whether the field is required
64
- * - `placeholder` - Placeholder text (for text/number fields)
65
- * - `public` - Whether the field value is publicly visible
66
- * - `internal` - Whether the field is for internal use only
67
- * - `options` - Array of options (for select/multi-select fields)
68
- *
69
- * ### Errors
70
- *
71
- * - `404` - Custom field not found in your organization
72
- *
73
- * @example
74
- * ```ts
75
- * const customField =
76
- * await client.feedback.customFields.retrieve(
77
- * '65d26304b2e65b1e1278170c',
78
- * );
79
- * ```
80
- */
81
- retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
82
82
  }
83
83
  export interface CustomField {
84
84
  /**
@@ -183,21 +183,21 @@ export declare namespace CustomFieldList {
183
183
  totalPages: number;
184
184
  }
185
185
  }
186
- export interface CustomFieldListParams {
186
+ export interface CustomFieldRetrieveParams {
187
187
  /**
188
188
  * API version for this request. Defaults to your organization's configured API
189
189
  * version if not specified.
190
190
  */
191
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
191
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
192
192
  }
193
- export interface CustomFieldRetrieveParams {
193
+ export interface CustomFieldListParams {
194
194
  /**
195
195
  * API version for this request. Defaults to your organization's configured API
196
196
  * version if not specified.
197
197
  */
198
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
198
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
199
199
  }
200
200
  export declare namespace CustomFields {
201
- export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldListParams as CustomFieldListParams, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, };
201
+ export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, type CustomFieldListParams as CustomFieldListParams, };
202
202
  }
203
203
  //# sourceMappingURL=custom-fields.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"custom-fields.d.mts","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;CAc3B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
1
+ {"version":3,"file":"custom-fields.d.mts","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAe1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAc/B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -5,6 +5,37 @@ import { RequestOptions } from "../../internal/request-options.js";
5
5
  * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
6
6
  */
7
7
  export declare class CustomFields extends APIResource {
8
+ /**
9
+ * Retrieves a single custom field by its unique identifier.
10
+ *
11
+ * Returns the custom field object if found in your organization.
12
+ *
13
+ * ### Response
14
+ *
15
+ * Returns a custom field object with:
16
+ *
17
+ * - `id` - Unique field identifier
18
+ * - `label` - Field label displayed to users
19
+ * - `type` - Field type (text, number, select, multi-select, checkbox, date)
20
+ * - `required` - Whether the field is required
21
+ * - `placeholder` - Placeholder text (for text/number fields)
22
+ * - `public` - Whether the field value is publicly visible
23
+ * - `internal` - Whether the field is for internal use only
24
+ * - `options` - Array of options (for select/multi-select fields)
25
+ *
26
+ * ### Errors
27
+ *
28
+ * - `404` - Custom field not found in your organization
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const customField =
33
+ * await client.feedback.customFields.retrieve(
34
+ * '65d26304b2e65b1e1278170c',
35
+ * );
36
+ * ```
37
+ */
38
+ retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
8
39
  /**
9
40
  * Returns all custom fields configured in your organization.
10
41
  *
@@ -48,37 +79,6 @@ export declare class CustomFields extends APIResource {
48
79
  * ```
49
80
  */
50
81
  list(params?: CustomFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomFieldList>;
51
- /**
52
- * Retrieves a single custom field by its unique identifier.
53
- *
54
- * Returns the custom field object if found in your organization.
55
- *
56
- * ### Response
57
- *
58
- * Returns a custom field object with:
59
- *
60
- * - `id` - Unique field identifier
61
- * - `label` - Field label displayed to users
62
- * - `type` - Field type (text, number, select, multi-select, checkbox, date)
63
- * - `required` - Whether the field is required
64
- * - `placeholder` - Placeholder text (for text/number fields)
65
- * - `public` - Whether the field value is publicly visible
66
- * - `internal` - Whether the field is for internal use only
67
- * - `options` - Array of options (for select/multi-select fields)
68
- *
69
- * ### Errors
70
- *
71
- * - `404` - Custom field not found in your organization
72
- *
73
- * @example
74
- * ```ts
75
- * const customField =
76
- * await client.feedback.customFields.retrieve(
77
- * '65d26304b2e65b1e1278170c',
78
- * );
79
- * ```
80
- */
81
- retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
82
82
  }
83
83
  export interface CustomField {
84
84
  /**
@@ -183,21 +183,21 @@ export declare namespace CustomFieldList {
183
183
  totalPages: number;
184
184
  }
185
185
  }
186
- export interface CustomFieldListParams {
186
+ export interface CustomFieldRetrieveParams {
187
187
  /**
188
188
  * API version for this request. Defaults to your organization's configured API
189
189
  * version if not specified.
190
190
  */
191
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
191
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
192
192
  }
193
- export interface CustomFieldRetrieveParams {
193
+ export interface CustomFieldListParams {
194
194
  /**
195
195
  * API version for this request. Defaults to your organization's configured API
196
196
  * version if not specified.
197
197
  */
198
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
198
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
199
199
  }
200
200
  export declare namespace CustomFields {
201
- export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldListParams as CustomFieldListParams, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, };
201
+ export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, type CustomFieldListParams as CustomFieldListParams, };
202
202
  }
203
203
  //# sourceMappingURL=custom-fields.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;CAc3B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
1
+ {"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAe1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAc/B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -10,22 +10,13 @@ const path_1 = require("../../internal/utils/path.js");
10
10
  */
11
11
  class CustomFields extends resource_1.APIResource {
12
12
  /**
13
- * Returns all custom fields configured in your organization.
14
- *
15
- * This endpoint returns all custom fields at once (typically a small list). No
16
- * pagination is supported.
17
- *
18
- * ### Response Format
19
- *
20
- * Returns a list object with:
13
+ * Retrieves a single custom field by its unique identifier.
21
14
  *
22
- * - `object` - Always "list"
23
- * - `data` - Array of custom field objects
24
- * - `nextCursor` - Always null
15
+ * Returns the custom field object if found in your organization.
25
16
  *
26
- * ### Custom Field Object
17
+ * ### Response
27
18
  *
28
- * Each custom field includes:
19
+ * Returns a custom field object with:
29
20
  *
30
21
  * - `id` - Unique field identifier
31
22
  * - `label` - Field label displayed to users
@@ -36,24 +27,21 @@ class CustomFields extends resource_1.APIResource {
36
27
  * - `internal` - Whether the field is for internal use only
37
28
  * - `options` - Array of options (for select/multi-select fields)
38
29
  *
39
- * ### Field Types
30
+ * ### Errors
40
31
  *
41
- * - `text` - Single line text input
42
- * - `number` - Numeric input
43
- * - `select` - Single-choice dropdown
44
- * - `multi-select` - Multiple-choice dropdown
45
- * - `checkbox` - Boolean checkbox
46
- * - `date` - Date picker
32
+ * - `404` - Custom field not found in your organization
47
33
  *
48
34
  * @example
49
35
  * ```ts
50
- * const customFieldList =
51
- * await client.feedback.customFields.list();
36
+ * const customField =
37
+ * await client.feedback.customFields.retrieve(
38
+ * '65d26304b2e65b1e1278170c',
39
+ * );
52
40
  * ```
53
41
  */
54
- list(params = {}, options) {
42
+ retrieve(id, params = {}, options) {
55
43
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
56
- return this._client.get('/v2/custom_fields', {
44
+ return this._client.get((0, path_1.path) `/v2/custom_fields/${id}`, {
57
45
  ...options,
58
46
  headers: (0, headers_1.buildHeaders)([
59
47
  {
@@ -66,13 +54,22 @@ class CustomFields extends resource_1.APIResource {
66
54
  });
67
55
  }
68
56
  /**
69
- * Retrieves a single custom field by its unique identifier.
57
+ * Returns all custom fields configured in your organization.
70
58
  *
71
- * Returns the custom field object if found in your organization.
59
+ * This endpoint returns all custom fields at once (typically a small list). No
60
+ * pagination is supported.
72
61
  *
73
- * ### Response
62
+ * ### Response Format
74
63
  *
75
- * Returns a custom field object with:
64
+ * Returns a list object with:
65
+ *
66
+ * - `object` - Always "list"
67
+ * - `data` - Array of custom field objects
68
+ * - `nextCursor` - Always null
69
+ *
70
+ * ### Custom Field Object
71
+ *
72
+ * Each custom field includes:
76
73
  *
77
74
  * - `id` - Unique field identifier
78
75
  * - `label` - Field label displayed to users
@@ -83,21 +80,24 @@ class CustomFields extends resource_1.APIResource {
83
80
  * - `internal` - Whether the field is for internal use only
84
81
  * - `options` - Array of options (for select/multi-select fields)
85
82
  *
86
- * ### Errors
83
+ * ### Field Types
87
84
  *
88
- * - `404` - Custom field not found in your organization
85
+ * - `text` - Single line text input
86
+ * - `number` - Numeric input
87
+ * - `select` - Single-choice dropdown
88
+ * - `multi-select` - Multiple-choice dropdown
89
+ * - `checkbox` - Boolean checkbox
90
+ * - `date` - Date picker
89
91
  *
90
92
  * @example
91
93
  * ```ts
92
- * const customField =
93
- * await client.feedback.customFields.retrieve(
94
- * '65d26304b2e65b1e1278170c',
95
- * );
94
+ * const customFieldList =
95
+ * await client.feedback.customFields.list();
96
96
  * ```
97
97
  */
98
- retrieve(id, params = {}, options) {
98
+ list(params = {}, options) {
99
99
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
100
- return this._client.get((0, path_1.path) `/v2/custom_fields/${id}`, {
100
+ return this._client.get('/v2/custom_fields', {
101
101
  ...options,
102
102
  headers: (0, headers_1.buildHeaders)([
103
103
  {
@@ -1 +1 @@
1
- {"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA7GD,oCA6GC"}
1
+ {"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../../src/resources/feedback/custom-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA7GD,oCA6GC"}