featurebase-node 0.0.2

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 (795) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/LICENSE +201 -0
  3. package/README.md +356 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +274 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +274 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +569 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +565 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +7 -0
  111. package/internal/qs/formats.d.ts.map +1 -0
  112. package/internal/qs/formats.js +13 -0
  113. package/internal/qs/formats.js.map +1 -0
  114. package/internal/qs/formats.mjs +9 -0
  115. package/internal/qs/formats.mjs.map +1 -0
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts +10 -0
  119. package/internal/qs/index.d.ts.map +1 -0
  120. package/internal/qs/index.js +14 -0
  121. package/internal/qs/index.js.map +1 -0
  122. package/internal/qs/index.mjs +10 -0
  123. package/internal/qs/index.mjs.map +1 -0
  124. package/internal/qs/stringify.d.mts +3 -0
  125. package/internal/qs/stringify.d.mts.map +1 -0
  126. package/internal/qs/stringify.d.ts +3 -0
  127. package/internal/qs/stringify.d.ts.map +1 -0
  128. package/internal/qs/stringify.js +277 -0
  129. package/internal/qs/stringify.js.map +1 -0
  130. package/internal/qs/stringify.mjs +274 -0
  131. package/internal/qs/stringify.mjs.map +1 -0
  132. package/internal/qs/types.d.mts +57 -0
  133. package/internal/qs/types.d.mts.map +1 -0
  134. package/internal/qs/types.d.ts +57 -0
  135. package/internal/qs/types.d.ts.map +1 -0
  136. package/internal/qs/types.js +3 -0
  137. package/internal/qs/types.js.map +1 -0
  138. package/internal/qs/types.mjs +2 -0
  139. package/internal/qs/types.mjs.map +1 -0
  140. package/internal/qs/utils.d.mts +15 -0
  141. package/internal/qs/utils.d.mts.map +1 -0
  142. package/internal/qs/utils.d.ts +15 -0
  143. package/internal/qs/utils.d.ts.map +1 -0
  144. package/internal/qs/utils.js +230 -0
  145. package/internal/qs/utils.js.map +1 -0
  146. package/internal/qs/utils.mjs +217 -0
  147. package/internal/qs/utils.mjs.map +1 -0
  148. package/internal/request-options.d.mts +75 -0
  149. package/internal/request-options.d.mts.map +1 -0
  150. package/internal/request-options.d.ts +75 -0
  151. package/internal/request-options.d.ts.map +1 -0
  152. package/internal/request-options.js +14 -0
  153. package/internal/request-options.js.map +1 -0
  154. package/internal/request-options.mjs +10 -0
  155. package/internal/request-options.mjs.map +1 -0
  156. package/internal/shim-types.d.mts +17 -0
  157. package/internal/shim-types.d.mts.map +1 -0
  158. package/internal/shim-types.d.ts +17 -0
  159. package/internal/shim-types.d.ts.map +1 -0
  160. package/internal/shim-types.js +4 -0
  161. package/internal/shim-types.js.map +1 -0
  162. package/internal/shim-types.mjs +3 -0
  163. package/internal/shim-types.mjs.map +1 -0
  164. package/internal/shims.d.mts +20 -0
  165. package/internal/shims.d.mts.map +1 -0
  166. package/internal/shims.d.ts +20 -0
  167. package/internal/shims.d.ts.map +1 -0
  168. package/internal/shims.js +92 -0
  169. package/internal/shims.js.map +1 -0
  170. package/internal/shims.mjs +85 -0
  171. package/internal/shims.mjs.map +1 -0
  172. package/internal/to-file.d.mts +45 -0
  173. package/internal/to-file.d.mts.map +1 -0
  174. package/internal/to-file.d.ts +45 -0
  175. package/internal/to-file.d.ts.map +1 -0
  176. package/internal/to-file.js +91 -0
  177. package/internal/to-file.js.map +1 -0
  178. package/internal/to-file.mjs +88 -0
  179. package/internal/to-file.mjs.map +1 -0
  180. package/internal/tslib.js +81 -0
  181. package/internal/tslib.mjs +17 -0
  182. package/internal/types.d.mts +69 -0
  183. package/internal/types.d.mts.map +1 -0
  184. package/internal/types.d.ts +69 -0
  185. package/internal/types.d.ts.map +1 -0
  186. package/internal/types.js +4 -0
  187. package/internal/types.js.map +1 -0
  188. package/internal/types.mjs +3 -0
  189. package/internal/types.mjs.map +1 -0
  190. package/internal/uploads.d.mts +42 -0
  191. package/internal/uploads.d.mts.map +1 -0
  192. package/internal/uploads.d.ts +42 -0
  193. package/internal/uploads.d.ts.map +1 -0
  194. package/internal/uploads.js +141 -0
  195. package/internal/uploads.js.map +1 -0
  196. package/internal/uploads.mjs +131 -0
  197. package/internal/uploads.mjs.map +1 -0
  198. package/internal/utils/base64.d.mts +3 -0
  199. package/internal/utils/base64.d.mts.map +1 -0
  200. package/internal/utils/base64.d.ts +3 -0
  201. package/internal/utils/base64.d.ts.map +1 -0
  202. package/internal/utils/base64.js +38 -0
  203. package/internal/utils/base64.js.map +1 -0
  204. package/internal/utils/base64.mjs +33 -0
  205. package/internal/utils/base64.mjs.map +1 -0
  206. package/internal/utils/bytes.d.mts +4 -0
  207. package/internal/utils/bytes.d.mts.map +1 -0
  208. package/internal/utils/bytes.d.ts +4 -0
  209. package/internal/utils/bytes.d.ts.map +1 -0
  210. package/internal/utils/bytes.js +31 -0
  211. package/internal/utils/bytes.js.map +1 -0
  212. package/internal/utils/bytes.mjs +26 -0
  213. package/internal/utils/bytes.mjs.map +1 -0
  214. package/internal/utils/env.d.mts +9 -0
  215. package/internal/utils/env.d.mts.map +1 -0
  216. package/internal/utils/env.d.ts +9 -0
  217. package/internal/utils/env.d.ts.map +1 -0
  218. package/internal/utils/env.js +22 -0
  219. package/internal/utils/env.js.map +1 -0
  220. package/internal/utils/env.mjs +18 -0
  221. package/internal/utils/env.mjs.map +1 -0
  222. package/internal/utils/log.d.mts +37 -0
  223. package/internal/utils/log.d.mts.map +1 -0
  224. package/internal/utils/log.d.ts +37 -0
  225. package/internal/utils/log.d.ts.map +1 -0
  226. package/internal/utils/log.js +85 -0
  227. package/internal/utils/log.js.map +1 -0
  228. package/internal/utils/log.mjs +79 -0
  229. package/internal/utils/log.mjs.map +1 -0
  230. package/internal/utils/path.d.mts +15 -0
  231. package/internal/utils/path.d.mts.map +1 -0
  232. package/internal/utils/path.d.ts +15 -0
  233. package/internal/utils/path.d.ts.map +1 -0
  234. package/internal/utils/path.js +79 -0
  235. package/internal/utils/path.js.map +1 -0
  236. package/internal/utils/path.mjs +74 -0
  237. package/internal/utils/path.mjs.map +1 -0
  238. package/internal/utils/query.d.mts +2 -0
  239. package/internal/utils/query.d.mts.map +1 -0
  240. package/internal/utils/query.d.ts +2 -0
  241. package/internal/utils/query.d.ts.map +1 -0
  242. package/internal/utils/query.js +10 -0
  243. package/internal/utils/query.js.map +1 -0
  244. package/internal/utils/query.mjs +6 -0
  245. package/internal/utils/query.mjs.map +1 -0
  246. package/internal/utils/sleep.d.mts +2 -0
  247. package/internal/utils/sleep.d.mts.map +1 -0
  248. package/internal/utils/sleep.d.ts +2 -0
  249. package/internal/utils/sleep.d.ts.map +1 -0
  250. package/internal/utils/sleep.js +7 -0
  251. package/internal/utils/sleep.js.map +1 -0
  252. package/internal/utils/sleep.mjs +3 -0
  253. package/internal/utils/sleep.mjs.map +1 -0
  254. package/internal/utils/uuid.d.mts +5 -0
  255. package/internal/utils/uuid.d.mts.map +1 -0
  256. package/internal/utils/uuid.d.ts +5 -0
  257. package/internal/utils/uuid.d.ts.map +1 -0
  258. package/internal/utils/uuid.js +19 -0
  259. package/internal/utils/uuid.js.map +1 -0
  260. package/internal/utils/uuid.mjs +15 -0
  261. package/internal/utils/uuid.mjs.map +1 -0
  262. package/internal/utils/values.d.mts +18 -0
  263. package/internal/utils/values.d.mts.map +1 -0
  264. package/internal/utils/values.d.ts +18 -0
  265. package/internal/utils/values.d.ts.map +1 -0
  266. package/internal/utils/values.js +112 -0
  267. package/internal/utils/values.js.map +1 -0
  268. package/internal/utils/values.mjs +94 -0
  269. package/internal/utils/values.mjs.map +1 -0
  270. package/internal/utils.d.mts +8 -0
  271. package/internal/utils.d.mts.map +1 -0
  272. package/internal/utils.d.ts +8 -0
  273. package/internal/utils.d.ts.map +1 -0
  274. package/internal/utils.js +12 -0
  275. package/internal/utils.js.map +1 -0
  276. package/internal/utils.mjs +9 -0
  277. package/internal/utils.mjs.map +1 -0
  278. package/package.json +143 -0
  279. package/resource.d.mts +2 -0
  280. package/resource.d.mts.map +1 -0
  281. package/resource.d.ts +2 -0
  282. package/resource.d.ts.map +1 -0
  283. package/resource.js +6 -0
  284. package/resource.js.map +1 -0
  285. package/resource.mjs +2 -0
  286. package/resource.mjs.map +1 -0
  287. package/resources/admins.d.mts +437 -0
  288. package/resources/admins.d.mts.map +1 -0
  289. package/resources/admins.d.ts +437 -0
  290. package/resources/admins.d.ts.map +1 -0
  291. package/resources/admins.js +157 -0
  292. package/resources/admins.js.map +1 -0
  293. package/resources/admins.mjs +153 -0
  294. package/resources/admins.mjs.map +1 -0
  295. package/resources/boards.d.mts +202 -0
  296. package/resources/boards.d.mts.map +1 -0
  297. package/resources/boards.d.ts +202 -0
  298. package/resources/boards.d.ts.map +1 -0
  299. package/resources/boards.js +52 -0
  300. package/resources/boards.js.map +1 -0
  301. package/resources/boards.mjs +48 -0
  302. package/resources/boards.mjs.map +1 -0
  303. package/resources/brands.d.mts +180 -0
  304. package/resources/brands.d.mts.map +1 -0
  305. package/resources/brands.d.ts +180 -0
  306. package/resources/brands.d.ts.map +1 -0
  307. package/resources/brands.js +130 -0
  308. package/resources/brands.js.map +1 -0
  309. package/resources/brands.mjs +126 -0
  310. package/resources/brands.mjs.map +1 -0
  311. package/resources/changelogs/changelogs.d.mts +723 -0
  312. package/resources/changelogs/changelogs.d.mts.map +1 -0
  313. package/resources/changelogs/changelogs.d.ts +723 -0
  314. package/resources/changelogs/changelogs.d.ts.map +1 -0
  315. package/resources/changelogs/changelogs.js +406 -0
  316. package/resources/changelogs/changelogs.js.map +1 -0
  317. package/resources/changelogs/changelogs.mjs +401 -0
  318. package/resources/changelogs/changelogs.mjs.map +1 -0
  319. package/resources/changelogs/index.d.mts +3 -0
  320. package/resources/changelogs/index.d.mts.map +1 -0
  321. package/resources/changelogs/index.d.ts +3 -0
  322. package/resources/changelogs/index.d.ts.map +1 -0
  323. package/resources/changelogs/index.js +9 -0
  324. package/resources/changelogs/index.js.map +1 -0
  325. package/resources/changelogs/index.mjs +4 -0
  326. package/resources/changelogs/index.mjs.map +1 -0
  327. package/resources/changelogs/subscribers.d.mts +145 -0
  328. package/resources/changelogs/subscribers.d.mts.map +1 -0
  329. package/resources/changelogs/subscribers.d.ts +145 -0
  330. package/resources/changelogs/subscribers.d.ts.map +1 -0
  331. package/resources/changelogs/subscribers.js +119 -0
  332. package/resources/changelogs/subscribers.js.map +1 -0
  333. package/resources/changelogs/subscribers.mjs +115 -0
  334. package/resources/changelogs/subscribers.mjs.map +1 -0
  335. package/resources/changelogs.d.mts +2 -0
  336. package/resources/changelogs.d.mts.map +1 -0
  337. package/resources/changelogs.d.ts +2 -0
  338. package/resources/changelogs.d.ts.map +1 -0
  339. package/resources/changelogs.js +6 -0
  340. package/resources/changelogs.js.map +1 -0
  341. package/resources/changelogs.mjs +3 -0
  342. package/resources/changelogs.mjs.map +1 -0
  343. package/resources/comments.d.mts +632 -0
  344. package/resources/comments.d.mts.map +1 -0
  345. package/resources/comments.d.ts +632 -0
  346. package/resources/comments.d.ts.map +1 -0
  347. package/resources/comments.js +397 -0
  348. package/resources/comments.js.map +1 -0
  349. package/resources/comments.mjs +393 -0
  350. package/resources/comments.mjs.map +1 -0
  351. package/resources/companies/companies.d.mts +497 -0
  352. package/resources/companies/companies.d.mts.map +1 -0
  353. package/resources/companies/companies.d.ts +497 -0
  354. package/resources/companies/companies.d.ts.map +1 -0
  355. package/resources/companies/companies.js +368 -0
  356. package/resources/companies/companies.js.map +1 -0
  357. package/resources/companies/companies.mjs +363 -0
  358. package/resources/companies/companies.mjs.map +1 -0
  359. package/resources/companies/contacts.d.mts +236 -0
  360. package/resources/companies/contacts.d.mts.map +1 -0
  361. package/resources/companies/contacts.d.ts +236 -0
  362. package/resources/companies/contacts.d.ts.map +1 -0
  363. package/resources/companies/contacts.js +218 -0
  364. package/resources/companies/contacts.js.map +1 -0
  365. package/resources/companies/contacts.mjs +214 -0
  366. package/resources/companies/contacts.mjs.map +1 -0
  367. package/resources/companies/index.d.mts +3 -0
  368. package/resources/companies/index.d.mts.map +1 -0
  369. package/resources/companies/index.d.ts +3 -0
  370. package/resources/companies/index.d.ts.map +1 -0
  371. package/resources/companies/index.js +9 -0
  372. package/resources/companies/index.js.map +1 -0
  373. package/resources/companies/index.mjs +4 -0
  374. package/resources/companies/index.mjs.map +1 -0
  375. package/resources/companies.d.mts +2 -0
  376. package/resources/companies.d.mts.map +1 -0
  377. package/resources/companies.d.ts +2 -0
  378. package/resources/companies.d.ts.map +1 -0
  379. package/resources/companies.js +6 -0
  380. package/resources/companies.js.map +1 -0
  381. package/resources/companies.mjs +3 -0
  382. package/resources/companies.mjs.map +1 -0
  383. package/resources/contacts/by-user-id/by-user-id.d.mts +147 -0
  384. package/resources/contacts/by-user-id/by-user-id.d.mts.map +1 -0
  385. package/resources/contacts/by-user-id/by-user-id.d.ts +147 -0
  386. package/resources/contacts/by-user-id/by-user-id.d.ts.map +1 -0
  387. package/resources/contacts/by-user-id/by-user-id.js +152 -0
  388. package/resources/contacts/by-user-id/by-user-id.js.map +1 -0
  389. package/resources/contacts/by-user-id/by-user-id.mjs +147 -0
  390. package/resources/contacts/by-user-id/by-user-id.mjs.map +1 -0
  391. package/resources/contacts/by-user-id/email-preferences.d.mts +199 -0
  392. package/resources/contacts/by-user-id/email-preferences.d.mts.map +1 -0
  393. package/resources/contacts/by-user-id/email-preferences.d.ts +199 -0
  394. package/resources/contacts/by-user-id/email-preferences.d.ts.map +1 -0
  395. package/resources/contacts/by-user-id/email-preferences.js +176 -0
  396. package/resources/contacts/by-user-id/email-preferences.js.map +1 -0
  397. package/resources/contacts/by-user-id/email-preferences.mjs +172 -0
  398. package/resources/contacts/by-user-id/email-preferences.mjs.map +1 -0
  399. package/resources/contacts/by-user-id/index.d.mts +3 -0
  400. package/resources/contacts/by-user-id/index.d.mts.map +1 -0
  401. package/resources/contacts/by-user-id/index.d.ts +3 -0
  402. package/resources/contacts/by-user-id/index.d.ts.map +1 -0
  403. package/resources/contacts/by-user-id/index.js +9 -0
  404. package/resources/contacts/by-user-id/index.js.map +1 -0
  405. package/resources/contacts/by-user-id/index.mjs +4 -0
  406. package/resources/contacts/by-user-id/index.mjs.map +1 -0
  407. package/resources/contacts/by-user-id.d.mts +2 -0
  408. package/resources/contacts/by-user-id.d.mts.map +1 -0
  409. package/resources/contacts/by-user-id.d.ts +2 -0
  410. package/resources/contacts/by-user-id.d.ts.map +1 -0
  411. package/resources/contacts/by-user-id.js +6 -0
  412. package/resources/contacts/by-user-id.js.map +1 -0
  413. package/resources/contacts/by-user-id.mjs +3 -0
  414. package/resources/contacts/by-user-id.mjs.map +1 -0
  415. package/resources/contacts/contacts.d.mts +708 -0
  416. package/resources/contacts/contacts.d.mts.map +1 -0
  417. package/resources/contacts/contacts.d.ts +708 -0
  418. package/resources/contacts/contacts.d.ts.map +1 -0
  419. package/resources/contacts/contacts.js +444 -0
  420. package/resources/contacts/contacts.js.map +1 -0
  421. package/resources/contacts/contacts.mjs +439 -0
  422. package/resources/contacts/contacts.mjs.map +1 -0
  423. package/resources/contacts/email-preferences.d.mts +334 -0
  424. package/resources/contacts/email-preferences.d.mts.map +1 -0
  425. package/resources/contacts/email-preferences.d.ts +334 -0
  426. package/resources/contacts/email-preferences.d.ts.map +1 -0
  427. package/resources/contacts/email-preferences.js +219 -0
  428. package/resources/contacts/email-preferences.js.map +1 -0
  429. package/resources/contacts/email-preferences.mjs +215 -0
  430. package/resources/contacts/email-preferences.mjs.map +1 -0
  431. package/resources/contacts/index.d.mts +4 -0
  432. package/resources/contacts/index.d.mts.map +1 -0
  433. package/resources/contacts/index.d.ts +4 -0
  434. package/resources/contacts/index.d.ts.map +1 -0
  435. package/resources/contacts/index.js +11 -0
  436. package/resources/contacts/index.js.map +1 -0
  437. package/resources/contacts/index.mjs +5 -0
  438. package/resources/contacts/index.mjs.map +1 -0
  439. package/resources/contacts.d.mts +2 -0
  440. package/resources/contacts.d.mts.map +1 -0
  441. package/resources/contacts.d.ts +2 -0
  442. package/resources/contacts.d.ts.map +1 -0
  443. package/resources/contacts.js +6 -0
  444. package/resources/contacts.js.map +1 -0
  445. package/resources/contacts.mjs +3 -0
  446. package/resources/contacts.mjs.map +1 -0
  447. package/resources/conversations/conversations.d.mts +2235 -0
  448. package/resources/conversations/conversations.d.mts.map +1 -0
  449. package/resources/conversations/conversations.d.ts +2235 -0
  450. package/resources/conversations/conversations.d.ts.map +1 -0
  451. package/resources/conversations/conversations.js +753 -0
  452. package/resources/conversations/conversations.js.map +1 -0
  453. package/resources/conversations/conversations.mjs +748 -0
  454. package/resources/conversations/conversations.mjs.map +1 -0
  455. package/resources/conversations/index.d.mts +4 -0
  456. package/resources/conversations/index.d.mts.map +1 -0
  457. package/resources/conversations/index.d.ts +4 -0
  458. package/resources/conversations/index.d.ts.map +1 -0
  459. package/resources/conversations/index.js +11 -0
  460. package/resources/conversations/index.js.map +1 -0
  461. package/resources/conversations/index.mjs +5 -0
  462. package/resources/conversations/index.mjs.map +1 -0
  463. package/resources/conversations/participants.d.mts +217 -0
  464. package/resources/conversations/participants.d.mts.map +1 -0
  465. package/resources/conversations/participants.d.ts +217 -0
  466. package/resources/conversations/participants.d.ts.map +1 -0
  467. package/resources/conversations/participants.js +185 -0
  468. package/resources/conversations/participants.js.map +1 -0
  469. package/resources/conversations/participants.mjs +181 -0
  470. package/resources/conversations/participants.mjs.map +1 -0
  471. package/resources/conversations/tags.d.mts +200 -0
  472. package/resources/conversations/tags.d.mts.map +1 -0
  473. package/resources/conversations/tags.d.ts +200 -0
  474. package/resources/conversations/tags.d.ts.map +1 -0
  475. package/resources/conversations/tags.js +138 -0
  476. package/resources/conversations/tags.js.map +1 -0
  477. package/resources/conversations/tags.mjs +134 -0
  478. package/resources/conversations/tags.mjs.map +1 -0
  479. package/resources/conversations.d.mts +2 -0
  480. package/resources/conversations.d.mts.map +1 -0
  481. package/resources/conversations.d.ts +2 -0
  482. package/resources/conversations.d.ts.map +1 -0
  483. package/resources/conversations.js +6 -0
  484. package/resources/conversations.js.map +1 -0
  485. package/resources/conversations.mjs +3 -0
  486. package/resources/conversations.mjs.map +1 -0
  487. package/resources/custom-fields.d.mts +189 -0
  488. package/resources/custom-fields.d.mts.map +1 -0
  489. package/resources/custom-fields.d.ts +189 -0
  490. package/resources/custom-fields.d.ts.map +1 -0
  491. package/resources/custom-fields.js +92 -0
  492. package/resources/custom-fields.js.map +1 -0
  493. package/resources/custom-fields.mjs +88 -0
  494. package/resources/custom-fields.mjs.map +1 -0
  495. package/resources/help-center/articles.d.mts +770 -0
  496. package/resources/help-center/articles.d.mts.map +1 -0
  497. package/resources/help-center/articles.d.ts +770 -0
  498. package/resources/help-center/articles.d.ts.map +1 -0
  499. package/resources/help-center/articles.js +296 -0
  500. package/resources/help-center/articles.js.map +1 -0
  501. package/resources/help-center/articles.mjs +292 -0
  502. package/resources/help-center/articles.mjs.map +1 -0
  503. package/resources/help-center/collections.d.mts +669 -0
  504. package/resources/help-center/collections.d.mts.map +1 -0
  505. package/resources/help-center/collections.d.ts +669 -0
  506. package/resources/help-center/collections.d.ts.map +1 -0
  507. package/resources/help-center/collections.js +278 -0
  508. package/resources/help-center/collections.js.map +1 -0
  509. package/resources/help-center/collections.mjs +274 -0
  510. package/resources/help-center/collections.mjs.map +1 -0
  511. package/resources/help-center/help-center.d.mts +22 -0
  512. package/resources/help-center/help-center.d.mts.map +1 -0
  513. package/resources/help-center/help-center.d.ts +22 -0
  514. package/resources/help-center/help-center.d.ts.map +1 -0
  515. package/resources/help-center/help-center.js +29 -0
  516. package/resources/help-center/help-center.js.map +1 -0
  517. package/resources/help-center/help-center.mjs +24 -0
  518. package/resources/help-center/help-center.mjs.map +1 -0
  519. package/resources/help-center/help-centers.d.mts +312 -0
  520. package/resources/help-center/help-centers.d.mts.map +1 -0
  521. package/resources/help-center/help-centers.d.ts +312 -0
  522. package/resources/help-center/help-centers.d.ts.map +1 -0
  523. package/resources/help-center/help-centers.js +111 -0
  524. package/resources/help-center/help-centers.js.map +1 -0
  525. package/resources/help-center/help-centers.mjs +107 -0
  526. package/resources/help-center/help-centers.mjs.map +1 -0
  527. package/resources/help-center/index.d.mts +6 -0
  528. package/resources/help-center/index.d.mts.map +1 -0
  529. package/resources/help-center/index.d.ts +6 -0
  530. package/resources/help-center/index.d.ts.map +1 -0
  531. package/resources/help-center/index.js +15 -0
  532. package/resources/help-center/index.js.map +1 -0
  533. package/resources/help-center/index.mjs +7 -0
  534. package/resources/help-center/index.mjs.map +1 -0
  535. package/resources/help-center/redirect-rules.d.mts +417 -0
  536. package/resources/help-center/redirect-rules.d.mts.map +1 -0
  537. package/resources/help-center/redirect-rules.d.ts +417 -0
  538. package/resources/help-center/redirect-rules.d.ts.map +1 -0
  539. package/resources/help-center/redirect-rules.js +297 -0
  540. package/resources/help-center/redirect-rules.js.map +1 -0
  541. package/resources/help-center/redirect-rules.mjs +293 -0
  542. package/resources/help-center/redirect-rules.mjs.map +1 -0
  543. package/resources/help-center.d.mts +2 -0
  544. package/resources/help-center.d.mts.map +1 -0
  545. package/resources/help-center.d.ts +2 -0
  546. package/resources/help-center.d.ts.map +1 -0
  547. package/resources/help-center.js +6 -0
  548. package/resources/help-center.js.map +1 -0
  549. package/resources/help-center.mjs +3 -0
  550. package/resources/help-center.mjs.map +1 -0
  551. package/resources/index.d.mts +18 -0
  552. package/resources/index.d.mts.map +1 -0
  553. package/resources/index.d.ts +18 -0
  554. package/resources/index.d.ts.map +1 -0
  555. package/resources/index.js +39 -0
  556. package/resources/index.js.map +1 -0
  557. package/resources/index.mjs +19 -0
  558. package/resources/index.mjs.map +1 -0
  559. package/resources/post-statuses.d.mts +74 -0
  560. package/resources/post-statuses.d.mts.map +1 -0
  561. package/resources/post-statuses.d.ts +74 -0
  562. package/resources/post-statuses.d.ts.map +1 -0
  563. package/resources/post-statuses.js +53 -0
  564. package/resources/post-statuses.js.map +1 -0
  565. package/resources/post-statuses.mjs +49 -0
  566. package/resources/post-statuses.mjs.map +1 -0
  567. package/resources/posts/index.d.mts +3 -0
  568. package/resources/posts/index.d.mts.map +1 -0
  569. package/resources/posts/index.d.ts +3 -0
  570. package/resources/posts/index.d.ts.map +1 -0
  571. package/resources/posts/index.js +9 -0
  572. package/resources/posts/index.js.map +1 -0
  573. package/resources/posts/index.mjs +4 -0
  574. package/resources/posts/index.mjs.map +1 -0
  575. package/resources/posts/posts.d.mts +799 -0
  576. package/resources/posts/posts.d.mts.map +1 -0
  577. package/resources/posts/posts.d.ts +799 -0
  578. package/resources/posts/posts.d.ts.map +1 -0
  579. package/resources/posts/posts.js +271 -0
  580. package/resources/posts/posts.js.map +1 -0
  581. package/resources/posts/posts.mjs +266 -0
  582. package/resources/posts/posts.mjs.map +1 -0
  583. package/resources/posts/voters.d.mts +359 -0
  584. package/resources/posts/voters.d.mts.map +1 -0
  585. package/resources/posts/voters.d.ts +359 -0
  586. package/resources/posts/voters.d.ts.map +1 -0
  587. package/resources/posts/voters.js +171 -0
  588. package/resources/posts/voters.js.map +1 -0
  589. package/resources/posts/voters.mjs +167 -0
  590. package/resources/posts/voters.mjs.map +1 -0
  591. package/resources/posts.d.mts +2 -0
  592. package/resources/posts.d.mts.map +1 -0
  593. package/resources/posts.d.ts +2 -0
  594. package/resources/posts.d.ts.map +1 -0
  595. package/resources/posts.js +6 -0
  596. package/resources/posts.js.map +1 -0
  597. package/resources/posts.mjs +3 -0
  598. package/resources/posts.mjs.map +1 -0
  599. package/resources/surveys.d.mts +451 -0
  600. package/resources/surveys.d.mts.map +1 -0
  601. package/resources/surveys.d.ts +451 -0
  602. package/resources/surveys.d.ts.map +1 -0
  603. package/resources/surveys.js +149 -0
  604. package/resources/surveys.js.map +1 -0
  605. package/resources/surveys.mjs +145 -0
  606. package/resources/surveys.mjs.map +1 -0
  607. package/resources/tags.d.mts +147 -0
  608. package/resources/tags.d.mts.map +1 -0
  609. package/resources/tags.d.ts +147 -0
  610. package/resources/tags.d.ts.map +1 -0
  611. package/resources/tags.js +100 -0
  612. package/resources/tags.js.map +1 -0
  613. package/resources/tags.mjs +96 -0
  614. package/resources/tags.mjs.map +1 -0
  615. package/resources/teams.d.mts +165 -0
  616. package/resources/teams.d.mts.map +1 -0
  617. package/resources/teams.d.ts +165 -0
  618. package/resources/teams.d.ts.map +1 -0
  619. package/resources/teams.js +120 -0
  620. package/resources/teams.js.map +1 -0
  621. package/resources/teams.mjs +116 -0
  622. package/resources/teams.mjs.map +1 -0
  623. package/resources/tickets/categories.d.mts +63 -0
  624. package/resources/tickets/categories.d.mts.map +1 -0
  625. package/resources/tickets/categories.d.ts +63 -0
  626. package/resources/tickets/categories.d.ts.map +1 -0
  627. package/resources/tickets/categories.js +67 -0
  628. package/resources/tickets/categories.js.map +1 -0
  629. package/resources/tickets/categories.mjs +63 -0
  630. package/resources/tickets/categories.mjs.map +1 -0
  631. package/resources/tickets/custom-fields.d.mts +80 -0
  632. package/resources/tickets/custom-fields.d.mts.map +1 -0
  633. package/resources/tickets/custom-fields.d.ts +80 -0
  634. package/resources/tickets/custom-fields.d.ts.map +1 -0
  635. package/resources/tickets/custom-fields.js +85 -0
  636. package/resources/tickets/custom-fields.js.map +1 -0
  637. package/resources/tickets/custom-fields.mjs +81 -0
  638. package/resources/tickets/custom-fields.mjs.map +1 -0
  639. package/resources/tickets/index.d.mts +5 -0
  640. package/resources/tickets/index.d.mts.map +1 -0
  641. package/resources/tickets/index.d.ts +5 -0
  642. package/resources/tickets/index.d.ts.map +1 -0
  643. package/resources/tickets/index.js +13 -0
  644. package/resources/tickets/index.js.map +1 -0
  645. package/resources/tickets/index.mjs +6 -0
  646. package/resources/tickets/index.mjs.map +1 -0
  647. package/resources/tickets/statuses.d.mts +59 -0
  648. package/resources/tickets/statuses.d.mts.map +1 -0
  649. package/resources/tickets/statuses.d.ts +59 -0
  650. package/resources/tickets/statuses.d.ts.map +1 -0
  651. package/resources/tickets/statuses.js +63 -0
  652. package/resources/tickets/statuses.js.map +1 -0
  653. package/resources/tickets/statuses.mjs +59 -0
  654. package/resources/tickets/statuses.mjs.map +1 -0
  655. package/resources/tickets/tickets.d.mts +794 -0
  656. package/resources/tickets/tickets.d.mts.map +1 -0
  657. package/resources/tickets/tickets.d.ts +794 -0
  658. package/resources/tickets/tickets.d.ts.map +1 -0
  659. package/resources/tickets/tickets.js +327 -0
  660. package/resources/tickets/tickets.js.map +1 -0
  661. package/resources/tickets/tickets.mjs +322 -0
  662. package/resources/tickets/tickets.mjs.map +1 -0
  663. package/resources/tickets.d.mts +2 -0
  664. package/resources/tickets.d.mts.map +1 -0
  665. package/resources/tickets.d.ts +2 -0
  666. package/resources/tickets.d.ts.map +1 -0
  667. package/resources/tickets.js +6 -0
  668. package/resources/tickets.js.map +1 -0
  669. package/resources/tickets.mjs +3 -0
  670. package/resources/tickets.mjs.map +1 -0
  671. package/resources/webhooks.d.mts +626 -0
  672. package/resources/webhooks.d.mts.map +1 -0
  673. package/resources/webhooks.d.ts +626 -0
  674. package/resources/webhooks.d.ts.map +1 -0
  675. package/resources/webhooks.js +442 -0
  676. package/resources/webhooks.js.map +1 -0
  677. package/resources/webhooks.mjs +438 -0
  678. package/resources/webhooks.mjs.map +1 -0
  679. package/resources.d.mts +2 -0
  680. package/resources.d.mts.map +1 -0
  681. package/resources.d.ts +2 -0
  682. package/resources.d.ts.map +1 -0
  683. package/resources.js +5 -0
  684. package/resources.js.map +1 -0
  685. package/resources.mjs +2 -0
  686. package/resources.mjs.map +1 -0
  687. package/src/api-promise.ts +2 -0
  688. package/src/client.ts +1169 -0
  689. package/src/core/README.md +3 -0
  690. package/src/core/api-promise.ts +92 -0
  691. package/src/core/error.ts +130 -0
  692. package/src/core/resource.ts +11 -0
  693. package/src/core/uploads.ts +2 -0
  694. package/src/error.ts +2 -0
  695. package/src/index.ts +22 -0
  696. package/src/internal/README.md +3 -0
  697. package/src/internal/builtin-types.ts +93 -0
  698. package/src/internal/detect-platform.ts +196 -0
  699. package/src/internal/errors.ts +33 -0
  700. package/src/internal/headers.ts +97 -0
  701. package/src/internal/parse.ts +56 -0
  702. package/src/internal/qs/LICENSE.md +13 -0
  703. package/src/internal/qs/README.md +3 -0
  704. package/src/internal/qs/formats.ts +10 -0
  705. package/src/internal/qs/index.ts +13 -0
  706. package/src/internal/qs/stringify.ts +385 -0
  707. package/src/internal/qs/types.ts +71 -0
  708. package/src/internal/qs/utils.ts +265 -0
  709. package/src/internal/request-options.ts +91 -0
  710. package/src/internal/shim-types.ts +26 -0
  711. package/src/internal/shims.ts +107 -0
  712. package/src/internal/to-file.ts +154 -0
  713. package/src/internal/types.ts +95 -0
  714. package/src/internal/uploads.ts +187 -0
  715. package/src/internal/utils/base64.ts +40 -0
  716. package/src/internal/utils/bytes.ts +32 -0
  717. package/src/internal/utils/env.ts +18 -0
  718. package/src/internal/utils/log.ts +126 -0
  719. package/src/internal/utils/path.ts +88 -0
  720. package/src/internal/utils/query.ts +7 -0
  721. package/src/internal/utils/sleep.ts +3 -0
  722. package/src/internal/utils/uuid.ts +17 -0
  723. package/src/internal/utils/values.ts +105 -0
  724. package/src/internal/utils.ts +9 -0
  725. package/src/lib/.keep +4 -0
  726. package/src/resource.ts +2 -0
  727. package/src/resources/admins.ts +557 -0
  728. package/src/resources/boards.ts +259 -0
  729. package/src/resources/brands.ts +232 -0
  730. package/src/resources/changelogs/changelogs.ts +1139 -0
  731. package/src/resources/changelogs/index.ts +23 -0
  732. package/src/resources/changelogs/subscribers.ts +226 -0
  733. package/src/resources/changelogs.ts +3 -0
  734. package/src/resources/comments.ts +786 -0
  735. package/src/resources/companies/companies.ts +632 -0
  736. package/src/resources/companies/contacts.ts +299 -0
  737. package/src/resources/companies/index.ts +21 -0
  738. package/src/resources/companies.ts +3 -0
  739. package/src/resources/contacts/by-user-id/by-user-id.ts +200 -0
  740. package/src/resources/contacts/by-user-id/email-preferences.ts +243 -0
  741. package/src/resources/contacts/by-user-id/index.ts +13 -0
  742. package/src/resources/contacts/by-user-id.ts +3 -0
  743. package/src/resources/contacts/contacts.ts +908 -0
  744. package/src/resources/contacts/email-preferences.ts +399 -0
  745. package/src/resources/contacts/index.ts +32 -0
  746. package/src/resources/contacts.ts +3 -0
  747. package/src/resources/conversations/conversations.ts +2721 -0
  748. package/src/resources/conversations/index.ts +31 -0
  749. package/src/resources/conversations/participants.ts +263 -0
  750. package/src/resources/conversations/tags.ts +252 -0
  751. package/src/resources/conversations.ts +3 -0
  752. package/src/resources/custom-fields.ts +249 -0
  753. package/src/resources/help-center/articles.ts +1231 -0
  754. package/src/resources/help-center/collections.ts +1065 -0
  755. package/src/resources/help-center/help-center.ts +125 -0
  756. package/src/resources/help-center/help-centers.ts +558 -0
  757. package/src/resources/help-center/index.ts +52 -0
  758. package/src/resources/help-center/redirect-rules.ts +711 -0
  759. package/src/resources/help-center.ts +3 -0
  760. package/src/resources/index.ts +179 -0
  761. package/src/resources/post-statuses.ts +119 -0
  762. package/src/resources/posts/index.ts +22 -0
  763. package/src/resources/posts/posts.ts +1019 -0
  764. package/src/resources/posts/voters.ts +453 -0
  765. package/src/resources/posts.ts +3 -0
  766. package/src/resources/surveys.ts +576 -0
  767. package/src/resources/tags.ts +226 -0
  768. package/src/resources/teams.ts +213 -0
  769. package/src/resources/tickets/categories.ts +101 -0
  770. package/src/resources/tickets/custom-fields.ts +116 -0
  771. package/src/resources/tickets/index.ts +28 -0
  772. package/src/resources/tickets/statuses.ts +97 -0
  773. package/src/resources/tickets/tickets.ts +1019 -0
  774. package/src/resources/tickets.ts +3 -0
  775. package/src/resources/webhooks.ts +850 -0
  776. package/src/resources.ts +1 -0
  777. package/src/tsconfig.json +11 -0
  778. package/src/uploads.ts +2 -0
  779. package/src/version.ts +1 -0
  780. package/uploads.d.mts +2 -0
  781. package/uploads.d.mts.map +1 -0
  782. package/uploads.d.ts +2 -0
  783. package/uploads.d.ts.map +1 -0
  784. package/uploads.js +6 -0
  785. package/uploads.js.map +1 -0
  786. package/uploads.mjs +2 -0
  787. package/uploads.mjs.map +1 -0
  788. package/version.d.mts +2 -0
  789. package/version.d.mts.map +1 -0
  790. package/version.d.ts +2 -0
  791. package/version.d.ts.map +1 -0
  792. package/version.js +5 -0
  793. package/version.js.map +1 -0
  794. package/version.mjs +2 -0
  795. package/version.mjs.map +1 -0
@@ -0,0 +1,1231 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as ArticlesAPI from './articles';
5
+ import { APIPromise } from '../../core/api-promise';
6
+ import { buildHeaders } from '../../internal/headers';
7
+ import { RequestOptions } from '../../internal/request-options';
8
+ import { path } from '../../internal/utils/path';
9
+
10
+ /**
11
+ * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
12
+ */
13
+ export class Articles extends APIResource {
14
+ /**
15
+ * Creates a new article in your organization's help center.
16
+ *
17
+ * ### Request Body
18
+ *
19
+ * Required attributes:
20
+ *
21
+ * - `title` - The title of the article
22
+ *
23
+ * Optional attributes:
24
+ *
25
+ * - `description` - A brief description of the article
26
+ * - `body` - The HTML content of the article (supports external image URLs and
27
+ * base64 data URIs)
28
+ * - `formatter` - Content formatter: "default" or "ai" (AI converts markdown/html
29
+ * to Featurebase format)
30
+ * - `parentId` - The ID of the parent collection
31
+ * - `icon` - Icon object with type and value
32
+ * - `state` - "live" or "draft" (defaults to "draft")
33
+ * - `translations` - Dictionary of translations keyed by locale
34
+ *
35
+ * ### Response
36
+ *
37
+ * Returns the created article object with:
38
+ *
39
+ * - `id` - Unique identifier
40
+ * - `title` - Article title
41
+ * - `description` - Article description
42
+ * - `body` - Article content (HTML)
43
+ * - `slug` - URL slug
44
+ * - `icon` - Article icon (emoji or custom)
45
+ * - `parentId` - Parent collection ID
46
+ * - `helpCenterId` - ID of the help center this article belongs to
47
+ * - `organization` - Organization ID
48
+ * - `state` - Article state (live or draft)
49
+ * - `author` - Author information (name, authorId, avatarUrl)
50
+ * - `translations` - Translations for different locales
51
+ * - `createdAt` - ISO 8601 timestamp when created
52
+ * - `updatedAt` - ISO 8601 timestamp when last updated
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * const article = await client.helpCenter.articles.create({
57
+ * title: 'Getting Started Guide',
58
+ * });
59
+ * ```
60
+ */
61
+ create(params: ArticleCreateParams, options?: RequestOptions): APIPromise<Article> {
62
+ const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
63
+ return this._client.post('/v2/help_center/articles', {
64
+ body,
65
+ ...options,
66
+ headers: buildHeaders([
67
+ { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
68
+ options?.headers,
69
+ ]),
70
+ });
71
+ }
72
+
73
+ /**
74
+ * Retrieves a specific article by its unique identifier.
75
+ *
76
+ * Returns the article object if found in your organization's help center.
77
+ *
78
+ * ### Query Parameters
79
+ *
80
+ * - `state` - Article state to retrieve: "live" or "draft" (default "live")
81
+ *
82
+ * ### Response
83
+ *
84
+ * Returns an article object with:
85
+ *
86
+ * - `id` - Unique identifier
87
+ * - `title` - Article title
88
+ * - `description` - Article description
89
+ * - `body` - Article content (HTML)
90
+ * - `slug` - URL slug
91
+ * - `icon` - Article icon (emoji or custom)
92
+ * - `parentId` - Parent collection ID
93
+ * - `helpCenterId` - ID of the help center this article belongs to
94
+ * - `organization` - Organization ID
95
+ * - `state` - Article state (live or draft)
96
+ * - `defaultLocale` - Default locale for content
97
+ * - `locale` - Current locale
98
+ * - `availableLocales` - Array of available locales
99
+ * - `publishedLocales` - Array of locales where article is published
100
+ * - `featurebaseUrl` - Featurebase URL for the article
101
+ * - `externalUrl` - External URL if custom domain is configured
102
+ * - `author` - Author information (name, authorId, avatarUrl)
103
+ * - `order` - Display order
104
+ * - `isPublished` - Whether the article is published
105
+ * - `isDraftDiffersFromLive` - Whether draft differs from live version
106
+ * - `translations` - Translations for different locales
107
+ * - `createdAt` - ISO 8601 timestamp when created
108
+ * - `updatedAt` - ISO 8601 timestamp when last updated
109
+ * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
110
+ *
111
+ * ### Errors
112
+ *
113
+ * - `404` - Article not found in your organization's help center
114
+ *
115
+ * @example
116
+ * ```ts
117
+ * const article = await client.helpCenter.articles.retrieve(
118
+ * '1234567',
119
+ * );
120
+ * ```
121
+ */
122
+ retrieve(
123
+ id: string,
124
+ params: ArticleRetrieveParams | null | undefined = {},
125
+ options?: RequestOptions,
126
+ ): APIPromise<Article> {
127
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
128
+ return this._client.get(path`/v2/help_center/articles/${id}`, {
129
+ query,
130
+ ...options,
131
+ headers: buildHeaders([
132
+ { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
133
+ options?.headers,
134
+ ]),
135
+ });
136
+ }
137
+
138
+ /**
139
+ * Updates an existing article. Only include the fields you wish to update.
140
+ *
141
+ * ### Path Parameters
142
+ *
143
+ * - `id` - The unique identifier of the article to update
144
+ *
145
+ * ### Request Body
146
+ *
147
+ * All fields are optional. Only provided fields will be updated:
148
+ *
149
+ * - `title` - The new title of the article
150
+ * - `description` - The new description of the article
151
+ * - `body` - The new HTML content of the article
152
+ * - `formatter` - Content formatter: "default" or "ai"
153
+ * - `icon` - Updated icon object for the article
154
+ * - `parentId` - New parent collection ID
155
+ * - `authorId` - ID of the new author (must be a member of the organization)
156
+ * - `state` - "live" or "draft" - if "live", publishes immediately
157
+ * - `translations` - Dictionary of updated translations keyed by locale
158
+ *
159
+ * ### Response
160
+ *
161
+ * Returns the updated article object with:
162
+ *
163
+ * - `id` - Unique identifier
164
+ * - `title` - Article title
165
+ * - `description` - Article description
166
+ * - `body` - Article content (HTML)
167
+ * - `slug` - URL slug
168
+ * - `icon` - Article icon (emoji or custom)
169
+ * - `parentId` - Parent collection ID
170
+ * - `helpCenterId` - ID of the help center this article belongs to
171
+ * - `organization` - Organization ID
172
+ * - `state` - Article state (live or draft)
173
+ * - `author` - Author information (name, authorId, avatarUrl)
174
+ * - `translations` - Translations for different locales
175
+ * - `createdAt` - ISO 8601 timestamp when created
176
+ * - `updatedAt` - ISO 8601 timestamp when last updated
177
+ *
178
+ * ### Errors
179
+ *
180
+ * - `404` - Article not found in your organization's help center
181
+ *
182
+ * @example
183
+ * ```ts
184
+ * const article = await client.helpCenter.articles.update(
185
+ * '1234567',
186
+ * );
187
+ * ```
188
+ */
189
+ update(id: string, params: ArticleUpdateParams, options?: RequestOptions): APIPromise<Article> {
190
+ const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
191
+ return this._client.patch(path`/v2/help_center/articles/${id}`, {
192
+ body,
193
+ ...options,
194
+ headers: buildHeaders([
195
+ { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
196
+ options?.headers,
197
+ ]),
198
+ });
199
+ }
200
+
201
+ /**
202
+ * Returns a paginated list of articles within your organization's help center.
203
+ *
204
+ * Articles are the main content pieces that contain documentation, guides, and
205
+ * FAQs.
206
+ *
207
+ * ### Query Parameters
208
+ *
209
+ * - `limit` - Number of items to return (1-100, default 10)
210
+ * - `cursor` - Cursor for pagination
211
+ * - `state` - Filter by article state: "live", "draft", or "all" (default "live")
212
+ * - `parentId` - Filter by parent collection ID
213
+ *
214
+ * ### Response Format
215
+ *
216
+ * Returns a list object with:
217
+ *
218
+ * - `object` - Always "list"
219
+ * - `data` - Array of article objects
220
+ * - `nextCursor` - Cursor for next page (null if no more results)
221
+ *
222
+ * ### Article Object
223
+ *
224
+ * Each article includes:
225
+ *
226
+ * - `id` - Unique identifier
227
+ * - `title` - Article title
228
+ * - `description` - Article description
229
+ * - `body` - Article content (HTML)
230
+ * - `slug` - URL slug
231
+ * - `icon` - Article icon (emoji or custom)
232
+ * - `parentId` - Parent collection ID
233
+ * - `helpCenterId` - ID of the help center this article belongs to
234
+ * - `organization` - Organization ID
235
+ * - `state` - Article state (live or draft)
236
+ * - `defaultLocale` - Default locale for content
237
+ * - `locale` - Current locale
238
+ * - `availableLocales` - Array of available locales
239
+ * - `publishedLocales` - Array of locales where article is published
240
+ * - `featurebaseUrl` - Featurebase URL for the article
241
+ * - `externalUrl` - External URL if custom domain is configured
242
+ * - `author` - Author information (name, authorId, avatarUrl)
243
+ * - `order` - Display order
244
+ * - `isPublished` - Whether the article is published
245
+ * - `isDraftDiffersFromLive` - Whether draft differs from live version
246
+ * - `translations` - Translations for different locales
247
+ * - `createdAt` - ISO 8601 timestamp when created
248
+ * - `updatedAt` - ISO 8601 timestamp when last updated
249
+ * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
250
+ *
251
+ * @example
252
+ * ```ts
253
+ * const articles = await client.helpCenter.articles.list();
254
+ * ```
255
+ */
256
+ list(
257
+ params: ArticleListParams | null | undefined = {},
258
+ options?: RequestOptions,
259
+ ): APIPromise<ArticleListResponse> {
260
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
261
+ return this._client.get('/v2/help_center/articles', {
262
+ query,
263
+ ...options,
264
+ headers: buildHeaders([
265
+ { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
266
+ options?.headers,
267
+ ]),
268
+ });
269
+ }
270
+
271
+ /**
272
+ * Deletes an existing article.
273
+ *
274
+ * ### Path Parameters
275
+ *
276
+ * - `id` - The unique identifier of the article to delete
277
+ *
278
+ * ### Response
279
+ *
280
+ * Returns a deletion confirmation object:
281
+ *
282
+ * - `id` - The ID of the deleted article
283
+ * - `object` - Always "article"
284
+ * - `deleted` - Always true
285
+ *
286
+ * ### Errors
287
+ *
288
+ * - `404` - Article not found in your organization's help center
289
+ *
290
+ * @example
291
+ * ```ts
292
+ * const article = await client.helpCenter.articles.delete(
293
+ * '1234567',
294
+ * );
295
+ * ```
296
+ */
297
+ delete(
298
+ id: string,
299
+ params: ArticleDeleteParams | null | undefined = {},
300
+ options?: RequestOptions,
301
+ ): APIPromise<ArticleDeleteResponse> {
302
+ const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
303
+ return this._client.delete(path`/v2/help_center/articles/${id}`, {
304
+ ...options,
305
+ headers: buildHeaders([
306
+ { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
307
+ options?.headers,
308
+ ]),
309
+ });
310
+ }
311
+ }
312
+
313
+ export interface Article {
314
+ /**
315
+ * Article unique identifier
316
+ */
317
+ id: string;
318
+
319
+ /**
320
+ * Available locales
321
+ */
322
+ availableLocales: Array<
323
+ | 'bn'
324
+ | 'bs'
325
+ | 'pt-BR'
326
+ | 'bg'
327
+ | 'ca'
328
+ | 'hr'
329
+ | 'cs'
330
+ | 'da'
331
+ | 'nl'
332
+ | 'en'
333
+ | 'et'
334
+ | 'fi'
335
+ | 'fr'
336
+ | 'de'
337
+ | 'el'
338
+ | 'hi'
339
+ | 'hu'
340
+ | 'id'
341
+ | 'it'
342
+ | 'ja'
343
+ | 'ko'
344
+ | 'lv'
345
+ | 'lt'
346
+ | 'ms'
347
+ | 'mn'
348
+ | 'nb'
349
+ | 'pl'
350
+ | 'pt'
351
+ | 'ro'
352
+ | 'ru'
353
+ | 'sr'
354
+ | 'zh-CN'
355
+ | 'sk'
356
+ | 'sl'
357
+ | 'es'
358
+ | 'sw'
359
+ | 'sv'
360
+ | 'th'
361
+ | 'zh-TW'
362
+ | 'tr'
363
+ | 'uk'
364
+ | 'vi'
365
+ >;
366
+
367
+ /**
368
+ * ISO 8601 timestamp when created
369
+ */
370
+ createdAt: string;
371
+
372
+ /**
373
+ * Help Center ID
374
+ */
375
+ helpCenterId: string;
376
+
377
+ /**
378
+ * Current locale
379
+ */
380
+ locale:
381
+ | 'bn'
382
+ | 'bs'
383
+ | 'pt-BR'
384
+ | 'bg'
385
+ | 'ca'
386
+ | 'hr'
387
+ | 'cs'
388
+ | 'da'
389
+ | 'nl'
390
+ | 'en'
391
+ | 'et'
392
+ | 'fi'
393
+ | 'fr'
394
+ | 'de'
395
+ | 'el'
396
+ | 'hi'
397
+ | 'hu'
398
+ | 'id'
399
+ | 'it'
400
+ | 'ja'
401
+ | 'ko'
402
+ | 'lv'
403
+ | 'lt'
404
+ | 'ms'
405
+ | 'mn'
406
+ | 'nb'
407
+ | 'pl'
408
+ | 'pt'
409
+ | 'ro'
410
+ | 'ru'
411
+ | 'sr'
412
+ | 'zh-CN'
413
+ | 'sk'
414
+ | 'sl'
415
+ | 'es'
416
+ | 'sw'
417
+ | 'sv'
418
+ | 'th'
419
+ | 'zh-TW'
420
+ | 'tr'
421
+ | 'uk'
422
+ | 'vi';
423
+
424
+ /**
425
+ * Object type identifier
426
+ */
427
+ object: 'article';
428
+
429
+ /**
430
+ * Organization ID
431
+ */
432
+ organization: string;
433
+
434
+ /**
435
+ * Article state
436
+ */
437
+ state: 'live' | 'draft';
438
+
439
+ /**
440
+ * ISO 8601 timestamp when last updated
441
+ */
442
+ updatedAt: string;
443
+
444
+ /**
445
+ * Article author
446
+ */
447
+ author?: ArticleAuthor;
448
+
449
+ /**
450
+ * Article body content (HTML)
451
+ */
452
+ body?: string;
453
+
454
+ /**
455
+ * Default locale
456
+ */
457
+ defaultLocale?:
458
+ | 'bn'
459
+ | 'bs'
460
+ | 'pt-BR'
461
+ | 'bg'
462
+ | 'ca'
463
+ | 'hr'
464
+ | 'cs'
465
+ | 'da'
466
+ | 'nl'
467
+ | 'en'
468
+ | 'et'
469
+ | 'fi'
470
+ | 'fr'
471
+ | 'de'
472
+ | 'el'
473
+ | 'hi'
474
+ | 'hu'
475
+ | 'id'
476
+ | 'it'
477
+ | 'ja'
478
+ | 'ko'
479
+ | 'lv'
480
+ | 'lt'
481
+ | 'ms'
482
+ | 'mn'
483
+ | 'nb'
484
+ | 'pl'
485
+ | 'pt'
486
+ | 'ro'
487
+ | 'ru'
488
+ | 'sr'
489
+ | 'zh-CN'
490
+ | 'sk'
491
+ | 'sl'
492
+ | 'es'
493
+ | 'sw'
494
+ | 'sv'
495
+ | 'th'
496
+ | 'zh-TW'
497
+ | 'tr'
498
+ | 'uk'
499
+ | 'vi';
500
+
501
+ /**
502
+ * Article description
503
+ */
504
+ description?: string;
505
+
506
+ /**
507
+ * External URL
508
+ */
509
+ externalUrl?: string;
510
+
511
+ /**
512
+ * Featurebase URL
513
+ */
514
+ featurebaseUrl?: string;
515
+
516
+ /**
517
+ * Article icon
518
+ */
519
+ icon?: Article.Icon | null;
520
+
521
+ /**
522
+ * Whether draft differs from live
523
+ */
524
+ isDraftDiffersFromLive?: boolean;
525
+
526
+ /**
527
+ * Whether the article is published
528
+ */
529
+ isPublished?: boolean;
530
+
531
+ /**
532
+ * ISO 8601 timestamp when live version was last updated
533
+ */
534
+ liveUpdatedAt?: string;
535
+
536
+ /**
537
+ * Display order
538
+ */
539
+ order?: number | null;
540
+
541
+ /**
542
+ * Parent collection ID
543
+ */
544
+ parentId?: string | null;
545
+
546
+ /**
547
+ * Path to article within help center hierarchy
548
+ */
549
+ path?: string;
550
+
551
+ /**
552
+ * Published locales
553
+ */
554
+ publishedLocales?: Array<
555
+ | 'bn'
556
+ | 'bs'
557
+ | 'pt-BR'
558
+ | 'bg'
559
+ | 'ca'
560
+ | 'hr'
561
+ | 'cs'
562
+ | 'da'
563
+ | 'nl'
564
+ | 'en'
565
+ | 'et'
566
+ | 'fi'
567
+ | 'fr'
568
+ | 'de'
569
+ | 'el'
570
+ | 'hi'
571
+ | 'hu'
572
+ | 'id'
573
+ | 'it'
574
+ | 'ja'
575
+ | 'ko'
576
+ | 'lv'
577
+ | 'lt'
578
+ | 'ms'
579
+ | 'mn'
580
+ | 'nb'
581
+ | 'pl'
582
+ | 'pt'
583
+ | 'ro'
584
+ | 'ru'
585
+ | 'sr'
586
+ | 'zh-CN'
587
+ | 'sk'
588
+ | 'sl'
589
+ | 'es'
590
+ | 'sw'
591
+ | 'sv'
592
+ | 'th'
593
+ | 'zh-TW'
594
+ | 'tr'
595
+ | 'uk'
596
+ | 'vi'
597
+ >;
598
+
599
+ /**
600
+ * URL slug
601
+ */
602
+ slug?: string;
603
+
604
+ /**
605
+ * Associated survey ID
606
+ */
607
+ surveyId?: string;
608
+
609
+ /**
610
+ * Article title
611
+ */
612
+ title?: string;
613
+
614
+ /**
615
+ * ISO 8601 timestamp when translation was created
616
+ */
617
+ translationCreatedAt?: string;
618
+
619
+ /**
620
+ * Translations by locale code
621
+ */
622
+ translations?: Article.Translations;
623
+
624
+ /**
625
+ * ISO 8601 timestamp when translation was last updated
626
+ */
627
+ translationUpdatedAt?: string;
628
+
629
+ /**
630
+ * Visibility settings
631
+ */
632
+ visibleBy?: Array<string>;
633
+ }
634
+
635
+ export namespace Article {
636
+ /**
637
+ * Article icon
638
+ */
639
+ export interface Icon {
640
+ /**
641
+ * Icon type
642
+ */
643
+ type: 'emoji' | 'custom';
644
+
645
+ /**
646
+ * Icon value (emoji or URL)
647
+ */
648
+ value: string;
649
+ }
650
+
651
+ /**
652
+ * Translations by locale code
653
+ */
654
+ export interface Translations {
655
+ id?: ArticlesAPI.ArticleTranslation;
656
+
657
+ bg?: ArticlesAPI.ArticleTranslation;
658
+
659
+ bn?: ArticlesAPI.ArticleTranslation;
660
+
661
+ bs?: ArticlesAPI.ArticleTranslation;
662
+
663
+ ca?: ArticlesAPI.ArticleTranslation;
664
+
665
+ cs?: ArticlesAPI.ArticleTranslation;
666
+
667
+ da?: ArticlesAPI.ArticleTranslation;
668
+
669
+ de?: ArticlesAPI.ArticleTranslation;
670
+
671
+ el?: ArticlesAPI.ArticleTranslation;
672
+
673
+ en?: ArticlesAPI.ArticleTranslation;
674
+
675
+ es?: ArticlesAPI.ArticleTranslation;
676
+
677
+ et?: ArticlesAPI.ArticleTranslation;
678
+
679
+ fi?: ArticlesAPI.ArticleTranslation;
680
+
681
+ fr?: ArticlesAPI.ArticleTranslation;
682
+
683
+ hi?: ArticlesAPI.ArticleTranslation;
684
+
685
+ hr?: ArticlesAPI.ArticleTranslation;
686
+
687
+ hu?: ArticlesAPI.ArticleTranslation;
688
+
689
+ it?: ArticlesAPI.ArticleTranslation;
690
+
691
+ ja?: ArticlesAPI.ArticleTranslation;
692
+
693
+ ko?: ArticlesAPI.ArticleTranslation;
694
+
695
+ lt?: ArticlesAPI.ArticleTranslation;
696
+
697
+ lv?: ArticlesAPI.ArticleTranslation;
698
+
699
+ mn?: ArticlesAPI.ArticleTranslation;
700
+
701
+ ms?: ArticlesAPI.ArticleTranslation;
702
+
703
+ nb?: ArticlesAPI.ArticleTranslation;
704
+
705
+ nl?: ArticlesAPI.ArticleTranslation;
706
+
707
+ pl?: ArticlesAPI.ArticleTranslation;
708
+
709
+ pt?: ArticlesAPI.ArticleTranslation;
710
+
711
+ 'pt-BR'?: ArticlesAPI.ArticleTranslation;
712
+
713
+ ro?: ArticlesAPI.ArticleTranslation;
714
+
715
+ ru?: ArticlesAPI.ArticleTranslation;
716
+
717
+ sk?: ArticlesAPI.ArticleTranslation;
718
+
719
+ sl?: ArticlesAPI.ArticleTranslation;
720
+
721
+ sr?: ArticlesAPI.ArticleTranslation;
722
+
723
+ sv?: ArticlesAPI.ArticleTranslation;
724
+
725
+ sw?: ArticlesAPI.ArticleTranslation;
726
+
727
+ th?: ArticlesAPI.ArticleTranslation;
728
+
729
+ tr?: ArticlesAPI.ArticleTranslation;
730
+
731
+ uk?: ArticlesAPI.ArticleTranslation;
732
+
733
+ vi?: ArticlesAPI.ArticleTranslation;
734
+
735
+ 'zh-CN'?: ArticlesAPI.ArticleTranslation;
736
+
737
+ 'zh-TW'?: ArticlesAPI.ArticleTranslation;
738
+ }
739
+ }
740
+
741
+ /**
742
+ * Article author
743
+ */
744
+ export interface ArticleAuthor {
745
+ /**
746
+ * Author user ID
747
+ */
748
+ authorId: string;
749
+
750
+ /**
751
+ * Author name
752
+ */
753
+ name: string;
754
+
755
+ /**
756
+ * Author avatar URL
757
+ */
758
+ avatarUrl?: string | null;
759
+ }
760
+
761
+ /**
762
+ * Icon object for the article
763
+ */
764
+ export interface ArticleIconInputNova {
765
+ /**
766
+ * Type of icon (emoji or predefined only)
767
+ */
768
+ type: 'emoji' | 'predefined';
769
+
770
+ /**
771
+ * Icon value
772
+ */
773
+ value: string;
774
+ }
775
+
776
+ export interface ArticleTranslation {
777
+ /**
778
+ * Article author
779
+ */
780
+ author?: ArticleAuthor;
781
+
782
+ /**
783
+ * Article body content (HTML)
784
+ */
785
+ body?: string;
786
+
787
+ /**
788
+ * ISO 8601 timestamp when translation was created
789
+ */
790
+ createdAt?: string;
791
+
792
+ /**
793
+ * Article description
794
+ */
795
+ description?: string;
796
+
797
+ /**
798
+ * External URL
799
+ */
800
+ externalUrl?: string;
801
+
802
+ /**
803
+ * Featurebase URL
804
+ */
805
+ featurebaseUrl?: string;
806
+
807
+ /**
808
+ * URL slug
809
+ */
810
+ slug?: string;
811
+
812
+ /**
813
+ * Article title
814
+ */
815
+ title?: string;
816
+
817
+ /**
818
+ * ISO 8601 timestamp when translation was last updated
819
+ */
820
+ updatedAt?: string;
821
+ }
822
+
823
+ export interface ArticleTranslationInputNova {
824
+ /**
825
+ * Article body content in this locale (HTML or markdown)
826
+ */
827
+ body?: string;
828
+
829
+ /**
830
+ * Article description in this locale
831
+ */
832
+ description?: string;
833
+
834
+ /**
835
+ * Article title in this locale
836
+ */
837
+ title?: string;
838
+ }
839
+
840
+ export interface ArticleListResponse {
841
+ /**
842
+ * Array of article objects
843
+ */
844
+ data: Array<Article>;
845
+
846
+ /**
847
+ * Cursor for fetching the next page (cursor-based pagination)
848
+ */
849
+ nextCursor: string | null;
850
+
851
+ /**
852
+ * Object type identifier
853
+ */
854
+ object: 'list';
855
+ }
856
+
857
+ export interface ArticleDeleteResponse {
858
+ /**
859
+ * Unique identifier of the deleted article
860
+ */
861
+ id: string;
862
+
863
+ /**
864
+ * Indicates the resource was deleted
865
+ */
866
+ deleted: true;
867
+
868
+ /**
869
+ * Object type identifier
870
+ */
871
+ object: 'article';
872
+ }
873
+
874
+ export interface ArticleCreateParams {
875
+ /**
876
+ * Body param: The title of the article
877
+ */
878
+ title: string;
879
+
880
+ /**
881
+ * Body param: The HTML content of the article (supports external image URLs and
882
+ * base64 data URIs)
883
+ */
884
+ body?: string;
885
+
886
+ /**
887
+ * Body param: A brief description of the article
888
+ */
889
+ description?: string;
890
+
891
+ /**
892
+ * Body param: Content formatter - "ai" converts markdown/html to Featurebase
893
+ * format using AI
894
+ */
895
+ formatter?: 'default' | 'ai';
896
+
897
+ /**
898
+ * Body param: Icon object for the article
899
+ */
900
+ icon?: ArticleIconInputNova | null;
901
+
902
+ /**
903
+ * Body param: The ID of the parent collection
904
+ */
905
+ parentId?: string;
906
+
907
+ /**
908
+ * Body param: Article state - "live" publishes immediately, "draft" saves as draft
909
+ */
910
+ state?: 'live' | 'draft';
911
+
912
+ /**
913
+ * Body param: Dictionary of translations keyed by locale code
914
+ */
915
+ translations?: ArticleCreateParams.Translations;
916
+
917
+ /**
918
+ * Header param: API version for this request. Defaults to your organization's
919
+ * configured API version if not specified.
920
+ */
921
+ 'Featurebase-Version'?: string;
922
+ }
923
+
924
+ export namespace ArticleCreateParams {
925
+ /**
926
+ * Dictionary of translations keyed by locale code
927
+ */
928
+ export interface Translations {
929
+ id?: ArticlesAPI.ArticleTranslationInputNova;
930
+
931
+ bg?: ArticlesAPI.ArticleTranslationInputNova;
932
+
933
+ bn?: ArticlesAPI.ArticleTranslationInputNova;
934
+
935
+ bs?: ArticlesAPI.ArticleTranslationInputNova;
936
+
937
+ ca?: ArticlesAPI.ArticleTranslationInputNova;
938
+
939
+ cs?: ArticlesAPI.ArticleTranslationInputNova;
940
+
941
+ da?: ArticlesAPI.ArticleTranslationInputNova;
942
+
943
+ de?: ArticlesAPI.ArticleTranslationInputNova;
944
+
945
+ el?: ArticlesAPI.ArticleTranslationInputNova;
946
+
947
+ en?: ArticlesAPI.ArticleTranslationInputNova;
948
+
949
+ es?: ArticlesAPI.ArticleTranslationInputNova;
950
+
951
+ et?: ArticlesAPI.ArticleTranslationInputNova;
952
+
953
+ fi?: ArticlesAPI.ArticleTranslationInputNova;
954
+
955
+ fr?: ArticlesAPI.ArticleTranslationInputNova;
956
+
957
+ hi?: ArticlesAPI.ArticleTranslationInputNova;
958
+
959
+ hr?: ArticlesAPI.ArticleTranslationInputNova;
960
+
961
+ hu?: ArticlesAPI.ArticleTranslationInputNova;
962
+
963
+ it?: ArticlesAPI.ArticleTranslationInputNova;
964
+
965
+ ja?: ArticlesAPI.ArticleTranslationInputNova;
966
+
967
+ ko?: ArticlesAPI.ArticleTranslationInputNova;
968
+
969
+ lt?: ArticlesAPI.ArticleTranslationInputNova;
970
+
971
+ lv?: ArticlesAPI.ArticleTranslationInputNova;
972
+
973
+ mn?: ArticlesAPI.ArticleTranslationInputNova;
974
+
975
+ ms?: ArticlesAPI.ArticleTranslationInputNova;
976
+
977
+ nb?: ArticlesAPI.ArticleTranslationInputNova;
978
+
979
+ nl?: ArticlesAPI.ArticleTranslationInputNova;
980
+
981
+ pl?: ArticlesAPI.ArticleTranslationInputNova;
982
+
983
+ pt?: ArticlesAPI.ArticleTranslationInputNova;
984
+
985
+ 'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
986
+
987
+ ro?: ArticlesAPI.ArticleTranslationInputNova;
988
+
989
+ ru?: ArticlesAPI.ArticleTranslationInputNova;
990
+
991
+ sk?: ArticlesAPI.ArticleTranslationInputNova;
992
+
993
+ sl?: ArticlesAPI.ArticleTranslationInputNova;
994
+
995
+ sr?: ArticlesAPI.ArticleTranslationInputNova;
996
+
997
+ sv?: ArticlesAPI.ArticleTranslationInputNova;
998
+
999
+ sw?: ArticlesAPI.ArticleTranslationInputNova;
1000
+
1001
+ th?: ArticlesAPI.ArticleTranslationInputNova;
1002
+
1003
+ tr?: ArticlesAPI.ArticleTranslationInputNova;
1004
+
1005
+ uk?: ArticlesAPI.ArticleTranslationInputNova;
1006
+
1007
+ vi?: ArticlesAPI.ArticleTranslationInputNova;
1008
+
1009
+ 'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
1010
+
1011
+ 'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
1012
+ }
1013
+ }
1014
+
1015
+ export interface ArticleRetrieveParams {
1016
+ /**
1017
+ * Query param: Article state to retrieve
1018
+ */
1019
+ state?: 'live' | 'draft';
1020
+
1021
+ /**
1022
+ * Header param: API version for this request. Defaults to your organization's
1023
+ * configured API version if not specified.
1024
+ */
1025
+ 'Featurebase-Version'?: string;
1026
+ }
1027
+
1028
+ export interface ArticleUpdateParams {
1029
+ /**
1030
+ * Body param: ID of the new author (must be a member of the organization)
1031
+ */
1032
+ authorId?: string;
1033
+
1034
+ /**
1035
+ * Body param: The new HTML content of the article
1036
+ */
1037
+ body?: string;
1038
+
1039
+ /**
1040
+ * Body param: The new description of the article
1041
+ */
1042
+ description?: string;
1043
+
1044
+ /**
1045
+ * Body param: Content formatter
1046
+ */
1047
+ formatter?: 'default' | 'ai';
1048
+
1049
+ /**
1050
+ * Body param: Icon object for the article
1051
+ */
1052
+ icon?: ArticleIconInputNova | null;
1053
+
1054
+ /**
1055
+ * Body param: New parent collection ID
1056
+ */
1057
+ parentId?: string | null;
1058
+
1059
+ /**
1060
+ * Body param: Article state - if "live", publishes immediately
1061
+ */
1062
+ state?: 'live' | 'draft';
1063
+
1064
+ /**
1065
+ * Body param: The new title of the article
1066
+ */
1067
+ title?: string;
1068
+
1069
+ /**
1070
+ * Body param: Dictionary of updated translations keyed by locale code
1071
+ */
1072
+ translations?: ArticleUpdateParams.Translations;
1073
+
1074
+ /**
1075
+ * Header param: API version for this request. Defaults to your organization's
1076
+ * configured API version if not specified.
1077
+ */
1078
+ 'Featurebase-Version'?: string;
1079
+ }
1080
+
1081
+ export namespace ArticleUpdateParams {
1082
+ /**
1083
+ * Dictionary of updated translations keyed by locale code
1084
+ */
1085
+ export interface Translations {
1086
+ id?: ArticlesAPI.ArticleTranslationInputNova;
1087
+
1088
+ bg?: ArticlesAPI.ArticleTranslationInputNova;
1089
+
1090
+ bn?: ArticlesAPI.ArticleTranslationInputNova;
1091
+
1092
+ bs?: ArticlesAPI.ArticleTranslationInputNova;
1093
+
1094
+ ca?: ArticlesAPI.ArticleTranslationInputNova;
1095
+
1096
+ cs?: ArticlesAPI.ArticleTranslationInputNova;
1097
+
1098
+ da?: ArticlesAPI.ArticleTranslationInputNova;
1099
+
1100
+ de?: ArticlesAPI.ArticleTranslationInputNova;
1101
+
1102
+ el?: ArticlesAPI.ArticleTranslationInputNova;
1103
+
1104
+ en?: ArticlesAPI.ArticleTranslationInputNova;
1105
+
1106
+ es?: ArticlesAPI.ArticleTranslationInputNova;
1107
+
1108
+ et?: ArticlesAPI.ArticleTranslationInputNova;
1109
+
1110
+ fi?: ArticlesAPI.ArticleTranslationInputNova;
1111
+
1112
+ fr?: ArticlesAPI.ArticleTranslationInputNova;
1113
+
1114
+ hi?: ArticlesAPI.ArticleTranslationInputNova;
1115
+
1116
+ hr?: ArticlesAPI.ArticleTranslationInputNova;
1117
+
1118
+ hu?: ArticlesAPI.ArticleTranslationInputNova;
1119
+
1120
+ it?: ArticlesAPI.ArticleTranslationInputNova;
1121
+
1122
+ ja?: ArticlesAPI.ArticleTranslationInputNova;
1123
+
1124
+ ko?: ArticlesAPI.ArticleTranslationInputNova;
1125
+
1126
+ lt?: ArticlesAPI.ArticleTranslationInputNova;
1127
+
1128
+ lv?: ArticlesAPI.ArticleTranslationInputNova;
1129
+
1130
+ mn?: ArticlesAPI.ArticleTranslationInputNova;
1131
+
1132
+ ms?: ArticlesAPI.ArticleTranslationInputNova;
1133
+
1134
+ nb?: ArticlesAPI.ArticleTranslationInputNova;
1135
+
1136
+ nl?: ArticlesAPI.ArticleTranslationInputNova;
1137
+
1138
+ pl?: ArticlesAPI.ArticleTranslationInputNova;
1139
+
1140
+ pt?: ArticlesAPI.ArticleTranslationInputNova;
1141
+
1142
+ 'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
1143
+
1144
+ ro?: ArticlesAPI.ArticleTranslationInputNova;
1145
+
1146
+ ru?: ArticlesAPI.ArticleTranslationInputNova;
1147
+
1148
+ sk?: ArticlesAPI.ArticleTranslationInputNova;
1149
+
1150
+ sl?: ArticlesAPI.ArticleTranslationInputNova;
1151
+
1152
+ sr?: ArticlesAPI.ArticleTranslationInputNova;
1153
+
1154
+ sv?: ArticlesAPI.ArticleTranslationInputNova;
1155
+
1156
+ sw?: ArticlesAPI.ArticleTranslationInputNova;
1157
+
1158
+ th?: ArticlesAPI.ArticleTranslationInputNova;
1159
+
1160
+ tr?: ArticlesAPI.ArticleTranslationInputNova;
1161
+
1162
+ uk?: ArticlesAPI.ArticleTranslationInputNova;
1163
+
1164
+ vi?: ArticlesAPI.ArticleTranslationInputNova;
1165
+
1166
+ 'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
1167
+
1168
+ 'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
1169
+ }
1170
+ }
1171
+
1172
+ export interface ArticleListParams {
1173
+ /**
1174
+ * Query param: An opaque cursor for pagination. Use the nextCursor value from a
1175
+ * previous response to fetch the next page of results.
1176
+ */
1177
+ cursor?: string;
1178
+
1179
+ /**
1180
+ * Query param: Filter articles by help center ID. If omitted, returns articles
1181
+ * across all help centers.
1182
+ */
1183
+ helpCenterId?: string;
1184
+
1185
+ /**
1186
+ * Query param: A limit on the number of objects to be returned, between 1 and 100.
1187
+ */
1188
+ limit?: number;
1189
+
1190
+ /**
1191
+ * Query param: Filter articles by parent collection ID
1192
+ */
1193
+ parentId?: string;
1194
+
1195
+ /**
1196
+ * Query param: Filter articles by state. Use "all" to get both draft and live
1197
+ * articles.
1198
+ */
1199
+ state?: 'live' | 'draft' | 'all';
1200
+
1201
+ /**
1202
+ * Header param: API version for this request. Defaults to your organization's
1203
+ * configured API version if not specified.
1204
+ */
1205
+ 'Featurebase-Version'?: string;
1206
+ }
1207
+
1208
+ export interface ArticleDeleteParams {
1209
+ /**
1210
+ * API version for this request. Defaults to your organization's configured API
1211
+ * version if not specified.
1212
+ */
1213
+ 'Featurebase-Version'?: string;
1214
+ }
1215
+
1216
+ export declare namespace Articles {
1217
+ export {
1218
+ type Article as Article,
1219
+ type ArticleAuthor as ArticleAuthor,
1220
+ type ArticleIconInputNova as ArticleIconInputNova,
1221
+ type ArticleTranslation as ArticleTranslation,
1222
+ type ArticleTranslationInputNova as ArticleTranslationInputNova,
1223
+ type ArticleListResponse as ArticleListResponse,
1224
+ type ArticleDeleteResponse as ArticleDeleteResponse,
1225
+ type ArticleCreateParams as ArticleCreateParams,
1226
+ type ArticleRetrieveParams as ArticleRetrieveParams,
1227
+ type ArticleUpdateParams as ArticleUpdateParams,
1228
+ type ArticleListParams as ArticleListParams,
1229
+ type ArticleDeleteParams as ArticleDeleteParams,
1230
+ };
1231
+ }