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,35 +11,31 @@ import { path } from '../../internal/utils/path';
11
11
  */
12
12
  export class Admins extends APIResource {
13
13
  /**
14
- * Returns all admins for your organization.
15
- *
16
- * This endpoint returns all admins at once (typically a small list). No pagination
17
- * is supported.
18
- *
19
- * ### Response Format
20
- *
21
- * Returns a list object with:
14
+ * Retrieves a single admin by their unique identifier.
22
15
  *
23
- * - `object` - Always "list"
24
- * - `data` - Array of admin objects
25
- * - `nextCursor` - Always null
16
+ * Returns the admin object if found and they belong to your organization.
26
17
  *
27
- * ### Admin Object
18
+ * ### Response
28
19
  *
29
- * Each admin includes:
20
+ * Returns an admin object with:
30
21
  *
31
22
  * - `id` - Unique admin identifier
32
23
  * - `name` - Admin's display name
33
24
  * - `email` - Admin's email address
34
25
  * - `picture` - Profile picture URL
35
26
  * - `roleId` - ID of the role assigned to this admin
27
+ *
28
+ * ### Errors
29
+ *
30
+ * - `404` - Admin not found or doesn't belong to your organization
36
31
  */
37
- list(
38
- params: AdminListParams | null | undefined = {},
32
+ retrieve(
33
+ id: string,
34
+ params: AdminRetrieveParams | null | undefined = {},
39
35
  options?: RequestOptions,
40
- ): APIPromise<AdminListResponse> {
36
+ ): APIPromise<Admin> {
41
37
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
42
- return this._client.get('/v2/admins', {
38
+ return this._client.get(path`/v2/admins/${id}`, {
43
39
  ...options,
44
40
  headers: buildHeaders([
45
41
  {
@@ -53,31 +49,35 @@ export class Admins extends APIResource {
53
49
  }
54
50
 
55
51
  /**
56
- * Retrieves a single admin by their unique identifier.
52
+ * Returns all admins for your organization.
57
53
  *
58
- * Returns the admin object if found and they belong to your organization.
54
+ * This endpoint returns all admins at once (typically a small list). No pagination
55
+ * is supported.
59
56
  *
60
- * ### Response
57
+ * ### Response Format
61
58
  *
62
- * Returns an admin object with:
59
+ * Returns a list object with:
60
+ *
61
+ * - `object` - Always "list"
62
+ * - `data` - Array of admin objects
63
+ * - `nextCursor` - Always null
64
+ *
65
+ * ### Admin Object
66
+ *
67
+ * Each admin includes:
63
68
  *
64
69
  * - `id` - Unique admin identifier
65
70
  * - `name` - Admin's display name
66
71
  * - `email` - Admin's email address
67
72
  * - `picture` - Profile picture URL
68
73
  * - `roleId` - ID of the role assigned to this admin
69
- *
70
- * ### Errors
71
- *
72
- * - `404` - Admin not found or doesn't belong to your organization
73
74
  */
74
- retrieve(
75
- id: string,
76
- params: AdminRetrieveParams | null | undefined = {},
75
+ list(
76
+ params: AdminListParams | null | undefined = {},
77
77
  options?: RequestOptions,
78
- ): APIPromise<Admin> {
78
+ ): APIPromise<AdminListResponse> {
79
79
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
80
- return this._client.get(path`/v2/admins/${id}`, {
80
+ return this._client.get('/v2/admins', {
81
81
  ...options,
82
82
  headers: buildHeaders([
83
83
  {
@@ -545,20 +545,20 @@ export namespace AdminListRolesResponse {
545
545
  }
546
546
  }
547
547
 
548
- export interface AdminListParams {
548
+ export interface AdminRetrieveParams {
549
549
  /**
550
550
  * API version for this request. Defaults to your organization's configured API
551
551
  * version if not specified.
552
552
  */
553
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
553
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
554
554
  }
555
555
 
556
- export interface AdminRetrieveParams {
556
+ export interface AdminListParams {
557
557
  /**
558
558
  * API version for this request. Defaults to your organization's configured API
559
559
  * version if not specified.
560
560
  */
561
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
561
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
562
562
  }
563
563
 
564
564
  export interface AdminListRolesParams {
@@ -566,7 +566,7 @@ export interface AdminListRolesParams {
566
566
  * API version for this request. Defaults to your organization's configured API
567
567
  * version if not specified.
568
568
  */
569
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
569
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
570
570
  }
571
571
 
572
572
  export declare namespace Admins {
@@ -574,8 +574,8 @@ export declare namespace Admins {
574
574
  type Admin as Admin,
575
575
  type AdminListResponse as AdminListResponse,
576
576
  type AdminListRolesResponse as AdminListRolesResponse,
577
- type AdminListParams as AdminListParams,
578
577
  type AdminRetrieveParams as AdminRetrieveParams,
578
+ type AdminListParams as AdminListParams,
579
579
  type AdminListRolesParams as AdminListRolesParams,
580
580
  };
581
581
  }
@@ -12,26 +12,17 @@ import { path } from '../../internal/utils/path';
12
12
  */
13
13
  export class Brands extends APIResource {
14
14
  /**
15
- * Returns all brands in your organization with cursor-based pagination.
16
- *
17
- * ### Query Parameters
18
- *
19
- * - `limit` - Number of brands to return (1-100, default: 10)
20
- * - `cursor` - Opaque cursor from a previous response for pagination
21
- *
22
- * ### Response Structure
15
+ * Retrieves a single brand by its Featurebase ID.
23
16
  *
24
- * The response includes:
17
+ * ### Path Parameters
25
18
  *
26
- * - `object` - Always "list"
27
- * - `data` - Array of brand objects
28
- * - `nextCursor` - Cursor for the next page (null if no more results)
19
+ * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
29
20
  *
30
- * ### Brand Object
21
+ * ### Response
31
22
  *
32
- * Each brand includes:
23
+ * Returns a brand object with:
33
24
  *
34
- * - `id` - Featurebase internal ID (MongoDB ObjectId)
25
+ * - `id` - Featurebase internal ID
35
26
  * - `name` - Brand display name
36
27
  * - `isDefault` - Whether this is the default brand
37
28
  * - `createdAt` - Creation timestamp
@@ -43,34 +34,32 @@ export class Brands extends APIResource {
43
34
  *
44
35
  * ```json
45
36
  * {
46
- * "object": "list",
47
- * "data": [
48
- * {
49
- * "object": "brand",
50
- * "id": "507f1f77bcf86cd799439011",
51
- * "name": "Default Brand",
52
- * "isDefault": true,
53
- * "createdAt": "2025-01-01T12:00:00.000Z",
54
- * "updatedAt": "2025-01-10T15:30:00.000Z",
55
- * "helpCenterId": "11",
56
- * "senderEmailAddressId": "507f1f77bcf86cd799439012"
57
- * }
58
- * ],
59
- * "nextCursor": null
37
+ * "object": "brand",
38
+ * "id": "507f1f77bcf86cd799439011",
39
+ * "name": "Default Brand",
40
+ * "isDefault": true,
41
+ * "createdAt": "2025-01-01T12:00:00.000Z",
42
+ * "updatedAt": "2025-01-10T15:30:00.000Z",
43
+ * "helpCenterId": "11",
44
+ * "senderEmailAddressId": "507f1f77bcf86cd799439012"
60
45
  * }
61
46
  * ```
62
47
  *
48
+ * ### Error Responses
49
+ *
50
+ * - **404 Not Found** - Brand with the specified ID does not exist
51
+ *
63
52
  * ### Version Availability
64
53
  *
65
54
  * This endpoint is only available in API version 2026-01-01.nova and newer.
66
55
  */
67
- list(
68
- params: BrandListParams | null | undefined = {},
56
+ retrieve(
57
+ id: string,
58
+ params: BrandRetrieveParams | null | undefined = {},
69
59
  options?: RequestOptions,
70
- ): PagePromise<BrandsCursorPage, Brand> {
71
- const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
72
- return this._client.getAPIList('/v2/brands', CursorPage<Brand>, {
73
- query,
60
+ ): APIPromise<Brand> {
61
+ const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
62
+ return this._client.get(path`/v2/brands/${id}`, {
74
63
  ...options,
75
64
  headers: buildHeaders([
76
65
  {
@@ -84,17 +73,26 @@ export class Brands extends APIResource {
84
73
  }
85
74
 
86
75
  /**
87
- * Retrieves a single brand by its Featurebase ID.
76
+ * Returns all brands in your organization with cursor-based pagination.
88
77
  *
89
- * ### Path Parameters
78
+ * ### Query Parameters
90
79
  *
91
- * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
80
+ * - `limit` - Number of brands to return (1-100, default: 10)
81
+ * - `cursor` - Opaque cursor from a previous response for pagination
92
82
  *
93
- * ### Response
83
+ * ### Response Structure
94
84
  *
95
- * Returns a brand object with:
85
+ * The response includes:
96
86
  *
97
- * - `id` - Featurebase internal ID
87
+ * - `object` - Always "list"
88
+ * - `data` - Array of brand objects
89
+ * - `nextCursor` - Cursor for the next page (null if no more results)
90
+ *
91
+ * ### Brand Object
92
+ *
93
+ * Each brand includes:
94
+ *
95
+ * - `id` - Featurebase internal ID (MongoDB ObjectId)
98
96
  * - `name` - Brand display name
99
97
  * - `isDefault` - Whether this is the default brand
100
98
  * - `createdAt` - Creation timestamp
@@ -106,32 +104,34 @@ export class Brands extends APIResource {
106
104
  *
107
105
  * ```json
108
106
  * {
109
- * "object": "brand",
110
- * "id": "507f1f77bcf86cd799439011",
111
- * "name": "Default Brand",
112
- * "isDefault": true,
113
- * "createdAt": "2025-01-01T12:00:00.000Z",
114
- * "updatedAt": "2025-01-10T15:30:00.000Z",
115
- * "helpCenterId": "11",
116
- * "senderEmailAddressId": "507f1f77bcf86cd799439012"
107
+ * "object": "list",
108
+ * "data": [
109
+ * {
110
+ * "object": "brand",
111
+ * "id": "507f1f77bcf86cd799439011",
112
+ * "name": "Default Brand",
113
+ * "isDefault": true,
114
+ * "createdAt": "2025-01-01T12:00:00.000Z",
115
+ * "updatedAt": "2025-01-10T15:30:00.000Z",
116
+ * "helpCenterId": "11",
117
+ * "senderEmailAddressId": "507f1f77bcf86cd799439012"
118
+ * }
119
+ * ],
120
+ * "nextCursor": null
117
121
  * }
118
122
  * ```
119
123
  *
120
- * ### Error Responses
121
- *
122
- * - **404 Not Found** - Brand with the specified ID does not exist
123
- *
124
124
  * ### Version Availability
125
125
  *
126
126
  * This endpoint is only available in API version 2026-01-01.nova and newer.
127
127
  */
128
- retrieve(
129
- id: string,
130
- params: BrandRetrieveParams | null | undefined = {},
128
+ list(
129
+ params: BrandListParams | null | undefined = {},
131
130
  options?: RequestOptions,
132
- ): APIPromise<Brand> {
133
- const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
134
- return this._client.get(path`/v2/brands/${id}`, {
131
+ ): PagePromise<BrandsCursorPage, Brand> {
132
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
133
+ return this._client.getAPIList('/v2/brands', CursorPage<Brand>, {
134
+ query,
135
135
  ...options,
136
136
  headers: buildHeaders([
137
137
  {
@@ -189,27 +189,27 @@ export interface Brand {
189
189
  updatedAt: string | null;
190
190
  }
191
191
 
192
- export interface BrandListParams extends CursorPageParams {
192
+ export interface BrandRetrieveParams {
193
193
  /**
194
- * Header param: API version for this request. Defaults to your organization's
195
- * configured API version if not specified.
194
+ * API version for this request. Defaults to your organization's configured API
195
+ * version if not specified.
196
196
  */
197
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
197
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
198
198
  }
199
199
 
200
- export interface BrandRetrieveParams {
200
+ export interface BrandListParams extends CursorPageParams {
201
201
  /**
202
- * API version for this request. Defaults to your organization's configured API
203
- * version if not specified.
202
+ * Header param: API version for this request. Defaults to your organization's
203
+ * configured API version if not specified.
204
204
  */
205
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
205
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
206
206
  }
207
207
 
208
208
  export declare namespace Brands {
209
209
  export {
210
210
  type Brand as Brand,
211
211
  type BrandsCursorPage as BrandsCursorPage,
212
- type BrandListParams as BrandListParams,
213
212
  type BrandRetrieveParams as BrandRetrieveParams,
213
+ type BrandListParams as BrandListParams,
214
214
  };
215
215
  }
@@ -5,15 +5,15 @@ export {
5
5
  type Admin,
6
6
  type AdminListResponse,
7
7
  type AdminListRolesResponse,
8
- type AdminListParams,
9
8
  type AdminRetrieveParams,
9
+ type AdminListParams,
10
10
  type AdminListRolesParams,
11
11
  } from './admins';
12
12
  export {
13
13
  Brands,
14
14
  type Brand,
15
- type BrandListParams,
16
15
  type BrandRetrieveParams,
16
+ type BrandListParams,
17
17
  type BrandsCursorPage,
18
18
  } from './brands';
19
19
  export { Organization } from './organization';
@@ -21,6 +21,6 @@ export {
21
21
  Teams,
22
22
  type Team,
23
23
  type TeamListResponse,
24
- type TeamListParams,
25
24
  type TeamRetrieveParams,
25
+ type TeamListParams,
26
26
  } from './teams';
@@ -32,8 +32,8 @@ export declare namespace Organization {
32
32
  type Admin as Admin,
33
33
  type AdminListResponse as AdminListResponse,
34
34
  type AdminListRolesResponse as AdminListRolesResponse,
35
- type AdminListParams as AdminListParams,
36
35
  type AdminRetrieveParams as AdminRetrieveParams,
36
+ type AdminListParams as AdminListParams,
37
37
  type AdminListRolesParams as AdminListRolesParams,
38
38
  };
39
39
 
@@ -41,15 +41,15 @@ export declare namespace Organization {
41
41
  Teams as Teams,
42
42
  type Team as Team,
43
43
  type TeamListResponse as TeamListResponse,
44
- type TeamListParams as TeamListParams,
45
44
  type TeamRetrieveParams as TeamRetrieveParams,
45
+ type TeamListParams as TeamListParams,
46
46
  };
47
47
 
48
48
  export {
49
49
  Brands as Brands,
50
50
  type Brand as Brand,
51
51
  type BrandsCursorPage as BrandsCursorPage,
52
- type BrandListParams as BrandListParams,
53
52
  type BrandRetrieveParams as BrandRetrieveParams,
53
+ type BrandListParams as BrandListParams,
54
54
  };
55
55
  }
@@ -11,18 +11,15 @@ import { path } from '../../internal/utils/path';
11
11
  */
12
12
  export class Teams extends APIResource {
13
13
  /**
14
- * Returns all teams in your organization.
15
- *
16
- * ### Response Structure
14
+ * Retrieves a single team by its Featurebase ID.
17
15
  *
18
- * The response includes:
16
+ * ### Path Parameters
19
17
  *
20
- * - `object` - Always "list"
21
- * - `data` - Array of team objects
18
+ * - `id` - The Featurebase internal ID of the team (MongoDB ObjectId)
22
19
  *
23
- * ### Team Object
20
+ * ### Response
24
21
  *
25
- * Each team includes:
22
+ * Returns a team object with:
26
23
  *
27
24
  * - `id` - Unique team identifier
28
25
  * - `name` - Team display name
@@ -34,33 +31,33 @@ export class Teams extends APIResource {
34
31
  *
35
32
  * ```json
36
33
  * {
37
- * "object": "list",
38
- * "data": [
39
- * {
40
- * "object": "team",
41
- * "id": "507f1f77bcf86cd799439011",
42
- * "name": "Support Team",
43
- * "color": "#3B82F6",
44
- * "icon": {
45
- * "value": "👥",
46
- * "type": "emoji"
47
- * },
48
- * "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
49
- * }
50
- * ]
34
+ * "object": "team",
35
+ * "id": "507f1f77bcf86cd799439011",
36
+ * "name": "Support Team",
37
+ * "color": "#3B82F6",
38
+ * "icon": {
39
+ * "value": "👥",
40
+ * "type": "emoji"
41
+ * },
42
+ * "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
51
43
  * }
52
44
  * ```
53
45
  *
46
+ * ### Error Responses
47
+ *
48
+ * - **404 Not Found** - Team with the specified ID does not exist
49
+ *
54
50
  * ### Version Availability
55
51
  *
56
52
  * This endpoint is only available in API version 2026-01-01.nova and newer.
57
53
  */
58
- list(
59
- params: TeamListParams | null | undefined = {},
54
+ retrieve(
55
+ id: string,
56
+ params: TeamRetrieveParams | null | undefined = {},
60
57
  options?: RequestOptions,
61
- ): APIPromise<TeamListResponse> {
58
+ ): APIPromise<Team> {
62
59
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
63
- return this._client.get('/v2/teams', {
60
+ return this._client.get(path`/v2/teams/${id}`, {
64
61
  ...options,
65
62
  headers: buildHeaders([
66
63
  {
@@ -74,15 +71,18 @@ export class Teams extends APIResource {
74
71
  }
75
72
 
76
73
  /**
77
- * Retrieves a single team by its Featurebase ID.
74
+ * Returns all teams in your organization.
78
75
  *
79
- * ### Path Parameters
76
+ * ### Response Structure
80
77
  *
81
- * - `id` - The Featurebase internal ID of the team (MongoDB ObjectId)
78
+ * The response includes:
82
79
  *
83
- * ### Response
80
+ * - `object` - Always "list"
81
+ * - `data` - Array of team objects
84
82
  *
85
- * Returns a team object with:
83
+ * ### Team Object
84
+ *
85
+ * Each team includes:
86
86
  *
87
87
  * - `id` - Unique team identifier
88
88
  * - `name` - Team display name
@@ -94,33 +94,33 @@ export class Teams extends APIResource {
94
94
  *
95
95
  * ```json
96
96
  * {
97
- * "object": "team",
98
- * "id": "507f1f77bcf86cd799439011",
99
- * "name": "Support Team",
100
- * "color": "#3B82F6",
101
- * "icon": {
102
- * "value": "👥",
103
- * "type": "emoji"
104
- * },
105
- * "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
97
+ * "object": "list",
98
+ * "data": [
99
+ * {
100
+ * "object": "team",
101
+ * "id": "507f1f77bcf86cd799439011",
102
+ * "name": "Support Team",
103
+ * "color": "#3B82F6",
104
+ * "icon": {
105
+ * "value": "👥",
106
+ * "type": "emoji"
107
+ * },
108
+ * "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
109
+ * }
110
+ * ]
106
111
  * }
107
112
  * ```
108
113
  *
109
- * ### Error Responses
110
- *
111
- * - **404 Not Found** - Team with the specified ID does not exist
112
- *
113
114
  * ### Version Availability
114
115
  *
115
116
  * This endpoint is only available in API version 2026-01-01.nova and newer.
116
117
  */
117
- retrieve(
118
- id: string,
119
- params: TeamRetrieveParams | null | undefined = {},
118
+ list(
119
+ params: TeamListParams | null | undefined = {},
120
120
  options?: RequestOptions,
121
- ): APIPromise<Team> {
121
+ ): APIPromise<TeamListResponse> {
122
122
  const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
123
- return this._client.get(path`/v2/teams/${id}`, {
123
+ return this._client.get('/v2/teams', {
124
124
  ...options,
125
125
  headers: buildHeaders([
126
126
  {
@@ -195,27 +195,27 @@ export interface TeamListResponse {
195
195
  object: 'list';
196
196
  }
197
197
 
198
- export interface TeamListParams {
198
+ export interface TeamRetrieveParams {
199
199
  /**
200
200
  * API version for this request. Defaults to your organization's configured API
201
201
  * version if not specified.
202
202
  */
203
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
203
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
204
204
  }
205
205
 
206
- export interface TeamRetrieveParams {
206
+ export interface TeamListParams {
207
207
  /**
208
208
  * API version for this request. Defaults to your organization's configured API
209
209
  * version if not specified.
210
210
  */
211
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
211
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
212
212
  }
213
213
 
214
214
  export declare namespace Teams {
215
215
  export {
216
216
  type Team as Team,
217
217
  type TeamListResponse as TeamListResponse,
218
- type TeamListParams as TeamListParams,
219
218
  type TeamRetrieveParams as TeamRetrieveParams,
219
+ type TeamListParams as TeamListParams,
220
220
  };
221
221
  }