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,770 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as ArticlesAPI from "./articles.mjs";
3
+ import { APIPromise } from "../../core/api-promise.mjs";
4
+ import { RequestOptions } from "../../internal/request-options.mjs";
5
+ /**
6
+ * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
7
+ */
8
+ export declare class Articles extends APIResource {
9
+ /**
10
+ * Creates a new article in your organization's help center.
11
+ *
12
+ * ### Request Body
13
+ *
14
+ * Required attributes:
15
+ *
16
+ * - `title` - The title of the article
17
+ *
18
+ * Optional attributes:
19
+ *
20
+ * - `description` - A brief description of the article
21
+ * - `body` - The HTML content of the article (supports external image URLs and
22
+ * base64 data URIs)
23
+ * - `formatter` - Content formatter: "default" or "ai" (AI converts markdown/html
24
+ * to Featurebase format)
25
+ * - `parentId` - The ID of the parent collection
26
+ * - `icon` - Icon object with type and value
27
+ * - `state` - "live" or "draft" (defaults to "draft")
28
+ * - `translations` - Dictionary of translations keyed by locale
29
+ *
30
+ * ### Response
31
+ *
32
+ * Returns the created article object with:
33
+ *
34
+ * - `id` - Unique identifier
35
+ * - `title` - Article title
36
+ * - `description` - Article description
37
+ * - `body` - Article content (HTML)
38
+ * - `slug` - URL slug
39
+ * - `icon` - Article icon (emoji or custom)
40
+ * - `parentId` - Parent collection ID
41
+ * - `helpCenterId` - ID of the help center this article belongs to
42
+ * - `organization` - Organization ID
43
+ * - `state` - Article state (live or draft)
44
+ * - `author` - Author information (name, authorId, avatarUrl)
45
+ * - `translations` - Translations for different locales
46
+ * - `createdAt` - ISO 8601 timestamp when created
47
+ * - `updatedAt` - ISO 8601 timestamp when last updated
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const article = await client.helpCenter.articles.create({
52
+ * title: 'Getting Started Guide',
53
+ * });
54
+ * ```
55
+ */
56
+ create(params: ArticleCreateParams, options?: RequestOptions): APIPromise<Article>;
57
+ /**
58
+ * Retrieves a specific article by its unique identifier.
59
+ *
60
+ * Returns the article object if found in your organization's help center.
61
+ *
62
+ * ### Query Parameters
63
+ *
64
+ * - `state` - Article state to retrieve: "live" or "draft" (default "live")
65
+ *
66
+ * ### Response
67
+ *
68
+ * Returns an article object with:
69
+ *
70
+ * - `id` - Unique identifier
71
+ * - `title` - Article title
72
+ * - `description` - Article description
73
+ * - `body` - Article content (HTML)
74
+ * - `slug` - URL slug
75
+ * - `icon` - Article icon (emoji or custom)
76
+ * - `parentId` - Parent collection ID
77
+ * - `helpCenterId` - ID of the help center this article belongs to
78
+ * - `organization` - Organization ID
79
+ * - `state` - Article state (live or draft)
80
+ * - `defaultLocale` - Default locale for content
81
+ * - `locale` - Current locale
82
+ * - `availableLocales` - Array of available locales
83
+ * - `publishedLocales` - Array of locales where article is published
84
+ * - `featurebaseUrl` - Featurebase URL for the article
85
+ * - `externalUrl` - External URL if custom domain is configured
86
+ * - `author` - Author information (name, authorId, avatarUrl)
87
+ * - `order` - Display order
88
+ * - `isPublished` - Whether the article is published
89
+ * - `isDraftDiffersFromLive` - Whether draft differs from live version
90
+ * - `translations` - Translations for different locales
91
+ * - `createdAt` - ISO 8601 timestamp when created
92
+ * - `updatedAt` - ISO 8601 timestamp when last updated
93
+ * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
94
+ *
95
+ * ### Errors
96
+ *
97
+ * - `404` - Article not found in your organization's help center
98
+ *
99
+ * @example
100
+ * ```ts
101
+ * const article = await client.helpCenter.articles.retrieve(
102
+ * '1234567',
103
+ * );
104
+ * ```
105
+ */
106
+ retrieve(id: string, params?: ArticleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Article>;
107
+ /**
108
+ * Updates an existing article. Only include the fields you wish to update.
109
+ *
110
+ * ### Path Parameters
111
+ *
112
+ * - `id` - The unique identifier of the article to update
113
+ *
114
+ * ### Request Body
115
+ *
116
+ * All fields are optional. Only provided fields will be updated:
117
+ *
118
+ * - `title` - The new title of the article
119
+ * - `description` - The new description of the article
120
+ * - `body` - The new HTML content of the article
121
+ * - `formatter` - Content formatter: "default" or "ai"
122
+ * - `icon` - Updated icon object for the article
123
+ * - `parentId` - New parent collection ID
124
+ * - `authorId` - ID of the new author (must be a member of the organization)
125
+ * - `state` - "live" or "draft" - if "live", publishes immediately
126
+ * - `translations` - Dictionary of updated translations keyed by locale
127
+ *
128
+ * ### Response
129
+ *
130
+ * Returns the updated article object with:
131
+ *
132
+ * - `id` - Unique identifier
133
+ * - `title` - Article title
134
+ * - `description` - Article description
135
+ * - `body` - Article content (HTML)
136
+ * - `slug` - URL slug
137
+ * - `icon` - Article icon (emoji or custom)
138
+ * - `parentId` - Parent collection ID
139
+ * - `helpCenterId` - ID of the help center this article belongs to
140
+ * - `organization` - Organization ID
141
+ * - `state` - Article state (live or draft)
142
+ * - `author` - Author information (name, authorId, avatarUrl)
143
+ * - `translations` - Translations for different locales
144
+ * - `createdAt` - ISO 8601 timestamp when created
145
+ * - `updatedAt` - ISO 8601 timestamp when last updated
146
+ *
147
+ * ### Errors
148
+ *
149
+ * - `404` - Article not found in your organization's help center
150
+ *
151
+ * @example
152
+ * ```ts
153
+ * const article = await client.helpCenter.articles.update(
154
+ * '1234567',
155
+ * );
156
+ * ```
157
+ */
158
+ update(id: string, params: ArticleUpdateParams, options?: RequestOptions): APIPromise<Article>;
159
+ /**
160
+ * Returns a paginated list of articles within your organization's help center.
161
+ *
162
+ * Articles are the main content pieces that contain documentation, guides, and
163
+ * FAQs.
164
+ *
165
+ * ### Query Parameters
166
+ *
167
+ * - `limit` - Number of items to return (1-100, default 10)
168
+ * - `cursor` - Cursor for pagination
169
+ * - `state` - Filter by article state: "live", "draft", or "all" (default "live")
170
+ * - `parentId` - Filter by parent collection ID
171
+ *
172
+ * ### Response Format
173
+ *
174
+ * Returns a list object with:
175
+ *
176
+ * - `object` - Always "list"
177
+ * - `data` - Array of article objects
178
+ * - `nextCursor` - Cursor for next page (null if no more results)
179
+ *
180
+ * ### Article Object
181
+ *
182
+ * Each article includes:
183
+ *
184
+ * - `id` - Unique identifier
185
+ * - `title` - Article title
186
+ * - `description` - Article description
187
+ * - `body` - Article content (HTML)
188
+ * - `slug` - URL slug
189
+ * - `icon` - Article icon (emoji or custom)
190
+ * - `parentId` - Parent collection ID
191
+ * - `helpCenterId` - ID of the help center this article belongs to
192
+ * - `organization` - Organization ID
193
+ * - `state` - Article state (live or draft)
194
+ * - `defaultLocale` - Default locale for content
195
+ * - `locale` - Current locale
196
+ * - `availableLocales` - Array of available locales
197
+ * - `publishedLocales` - Array of locales where article is published
198
+ * - `featurebaseUrl` - Featurebase URL for the article
199
+ * - `externalUrl` - External URL if custom domain is configured
200
+ * - `author` - Author information (name, authorId, avatarUrl)
201
+ * - `order` - Display order
202
+ * - `isPublished` - Whether the article is published
203
+ * - `isDraftDiffersFromLive` - Whether draft differs from live version
204
+ * - `translations` - Translations for different locales
205
+ * - `createdAt` - ISO 8601 timestamp when created
206
+ * - `updatedAt` - ISO 8601 timestamp when last updated
207
+ * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
208
+ *
209
+ * @example
210
+ * ```ts
211
+ * const articles = await client.helpCenter.articles.list();
212
+ * ```
213
+ */
214
+ list(params?: ArticleListParams | null | undefined, options?: RequestOptions): APIPromise<ArticleListResponse>;
215
+ /**
216
+ * Deletes an existing article.
217
+ *
218
+ * ### Path Parameters
219
+ *
220
+ * - `id` - The unique identifier of the article to delete
221
+ *
222
+ * ### Response
223
+ *
224
+ * Returns a deletion confirmation object:
225
+ *
226
+ * - `id` - The ID of the deleted article
227
+ * - `object` - Always "article"
228
+ * - `deleted` - Always true
229
+ *
230
+ * ### Errors
231
+ *
232
+ * - `404` - Article not found in your organization's help center
233
+ *
234
+ * @example
235
+ * ```ts
236
+ * const article = await client.helpCenter.articles.delete(
237
+ * '1234567',
238
+ * );
239
+ * ```
240
+ */
241
+ delete(id: string, params?: ArticleDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ArticleDeleteResponse>;
242
+ }
243
+ export interface Article {
244
+ /**
245
+ * Article unique identifier
246
+ */
247
+ id: string;
248
+ /**
249
+ * Available locales
250
+ */
251
+ availableLocales: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
252
+ /**
253
+ * ISO 8601 timestamp when created
254
+ */
255
+ createdAt: string;
256
+ /**
257
+ * Help Center ID
258
+ */
259
+ helpCenterId: string;
260
+ /**
261
+ * Current locale
262
+ */
263
+ locale: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
264
+ /**
265
+ * Object type identifier
266
+ */
267
+ object: 'article';
268
+ /**
269
+ * Organization ID
270
+ */
271
+ organization: string;
272
+ /**
273
+ * Article state
274
+ */
275
+ state: 'live' | 'draft';
276
+ /**
277
+ * ISO 8601 timestamp when last updated
278
+ */
279
+ updatedAt: string;
280
+ /**
281
+ * Article author
282
+ */
283
+ author?: ArticleAuthor;
284
+ /**
285
+ * Article body content (HTML)
286
+ */
287
+ body?: string;
288
+ /**
289
+ * Default locale
290
+ */
291
+ defaultLocale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
292
+ /**
293
+ * Article description
294
+ */
295
+ description?: string;
296
+ /**
297
+ * External URL
298
+ */
299
+ externalUrl?: string;
300
+ /**
301
+ * Featurebase URL
302
+ */
303
+ featurebaseUrl?: string;
304
+ /**
305
+ * Article icon
306
+ */
307
+ icon?: Article.Icon | null;
308
+ /**
309
+ * Whether draft differs from live
310
+ */
311
+ isDraftDiffersFromLive?: boolean;
312
+ /**
313
+ * Whether the article is published
314
+ */
315
+ isPublished?: boolean;
316
+ /**
317
+ * ISO 8601 timestamp when live version was last updated
318
+ */
319
+ liveUpdatedAt?: string;
320
+ /**
321
+ * Display order
322
+ */
323
+ order?: number | null;
324
+ /**
325
+ * Parent collection ID
326
+ */
327
+ parentId?: string | null;
328
+ /**
329
+ * Path to article within help center hierarchy
330
+ */
331
+ path?: string;
332
+ /**
333
+ * Published locales
334
+ */
335
+ publishedLocales?: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
336
+ /**
337
+ * URL slug
338
+ */
339
+ slug?: string;
340
+ /**
341
+ * Associated survey ID
342
+ */
343
+ surveyId?: string;
344
+ /**
345
+ * Article title
346
+ */
347
+ title?: string;
348
+ /**
349
+ * ISO 8601 timestamp when translation was created
350
+ */
351
+ translationCreatedAt?: string;
352
+ /**
353
+ * Translations by locale code
354
+ */
355
+ translations?: Article.Translations;
356
+ /**
357
+ * ISO 8601 timestamp when translation was last updated
358
+ */
359
+ translationUpdatedAt?: string;
360
+ /**
361
+ * Visibility settings
362
+ */
363
+ visibleBy?: Array<string>;
364
+ }
365
+ export declare namespace Article {
366
+ /**
367
+ * Article icon
368
+ */
369
+ interface Icon {
370
+ /**
371
+ * Icon type
372
+ */
373
+ type: 'emoji' | 'custom';
374
+ /**
375
+ * Icon value (emoji or URL)
376
+ */
377
+ value: string;
378
+ }
379
+ /**
380
+ * Translations by locale code
381
+ */
382
+ interface Translations {
383
+ id?: ArticlesAPI.ArticleTranslation;
384
+ bg?: ArticlesAPI.ArticleTranslation;
385
+ bn?: ArticlesAPI.ArticleTranslation;
386
+ bs?: ArticlesAPI.ArticleTranslation;
387
+ ca?: ArticlesAPI.ArticleTranslation;
388
+ cs?: ArticlesAPI.ArticleTranslation;
389
+ da?: ArticlesAPI.ArticleTranslation;
390
+ de?: ArticlesAPI.ArticleTranslation;
391
+ el?: ArticlesAPI.ArticleTranslation;
392
+ en?: ArticlesAPI.ArticleTranslation;
393
+ es?: ArticlesAPI.ArticleTranslation;
394
+ et?: ArticlesAPI.ArticleTranslation;
395
+ fi?: ArticlesAPI.ArticleTranslation;
396
+ fr?: ArticlesAPI.ArticleTranslation;
397
+ hi?: ArticlesAPI.ArticleTranslation;
398
+ hr?: ArticlesAPI.ArticleTranslation;
399
+ hu?: ArticlesAPI.ArticleTranslation;
400
+ it?: ArticlesAPI.ArticleTranslation;
401
+ ja?: ArticlesAPI.ArticleTranslation;
402
+ ko?: ArticlesAPI.ArticleTranslation;
403
+ lt?: ArticlesAPI.ArticleTranslation;
404
+ lv?: ArticlesAPI.ArticleTranslation;
405
+ mn?: ArticlesAPI.ArticleTranslation;
406
+ ms?: ArticlesAPI.ArticleTranslation;
407
+ nb?: ArticlesAPI.ArticleTranslation;
408
+ nl?: ArticlesAPI.ArticleTranslation;
409
+ pl?: ArticlesAPI.ArticleTranslation;
410
+ pt?: ArticlesAPI.ArticleTranslation;
411
+ 'pt-BR'?: ArticlesAPI.ArticleTranslation;
412
+ ro?: ArticlesAPI.ArticleTranslation;
413
+ ru?: ArticlesAPI.ArticleTranslation;
414
+ sk?: ArticlesAPI.ArticleTranslation;
415
+ sl?: ArticlesAPI.ArticleTranslation;
416
+ sr?: ArticlesAPI.ArticleTranslation;
417
+ sv?: ArticlesAPI.ArticleTranslation;
418
+ sw?: ArticlesAPI.ArticleTranslation;
419
+ th?: ArticlesAPI.ArticleTranslation;
420
+ tr?: ArticlesAPI.ArticleTranslation;
421
+ uk?: ArticlesAPI.ArticleTranslation;
422
+ vi?: ArticlesAPI.ArticleTranslation;
423
+ 'zh-CN'?: ArticlesAPI.ArticleTranslation;
424
+ 'zh-TW'?: ArticlesAPI.ArticleTranslation;
425
+ }
426
+ }
427
+ /**
428
+ * Article author
429
+ */
430
+ export interface ArticleAuthor {
431
+ /**
432
+ * Author user ID
433
+ */
434
+ authorId: string;
435
+ /**
436
+ * Author name
437
+ */
438
+ name: string;
439
+ /**
440
+ * Author avatar URL
441
+ */
442
+ avatarUrl?: string | null;
443
+ }
444
+ /**
445
+ * Icon object for the article
446
+ */
447
+ export interface ArticleIconInputNova {
448
+ /**
449
+ * Type of icon (emoji or predefined only)
450
+ */
451
+ type: 'emoji' | 'predefined';
452
+ /**
453
+ * Icon value
454
+ */
455
+ value: string;
456
+ }
457
+ export interface ArticleTranslation {
458
+ /**
459
+ * Article author
460
+ */
461
+ author?: ArticleAuthor;
462
+ /**
463
+ * Article body content (HTML)
464
+ */
465
+ body?: string;
466
+ /**
467
+ * ISO 8601 timestamp when translation was created
468
+ */
469
+ createdAt?: string;
470
+ /**
471
+ * Article description
472
+ */
473
+ description?: string;
474
+ /**
475
+ * External URL
476
+ */
477
+ externalUrl?: string;
478
+ /**
479
+ * Featurebase URL
480
+ */
481
+ featurebaseUrl?: string;
482
+ /**
483
+ * URL slug
484
+ */
485
+ slug?: string;
486
+ /**
487
+ * Article title
488
+ */
489
+ title?: string;
490
+ /**
491
+ * ISO 8601 timestamp when translation was last updated
492
+ */
493
+ updatedAt?: string;
494
+ }
495
+ export interface ArticleTranslationInputNova {
496
+ /**
497
+ * Article body content in this locale (HTML or markdown)
498
+ */
499
+ body?: string;
500
+ /**
501
+ * Article description in this locale
502
+ */
503
+ description?: string;
504
+ /**
505
+ * Article title in this locale
506
+ */
507
+ title?: string;
508
+ }
509
+ export interface ArticleListResponse {
510
+ /**
511
+ * Array of article objects
512
+ */
513
+ data: Array<Article>;
514
+ /**
515
+ * Cursor for fetching the next page (cursor-based pagination)
516
+ */
517
+ nextCursor: string | null;
518
+ /**
519
+ * Object type identifier
520
+ */
521
+ object: 'list';
522
+ }
523
+ export interface ArticleDeleteResponse {
524
+ /**
525
+ * Unique identifier of the deleted article
526
+ */
527
+ id: string;
528
+ /**
529
+ * Indicates the resource was deleted
530
+ */
531
+ deleted: true;
532
+ /**
533
+ * Object type identifier
534
+ */
535
+ object: 'article';
536
+ }
537
+ export interface ArticleCreateParams {
538
+ /**
539
+ * Body param: The title of the article
540
+ */
541
+ title: string;
542
+ /**
543
+ * Body param: The HTML content of the article (supports external image URLs and
544
+ * base64 data URIs)
545
+ */
546
+ body?: string;
547
+ /**
548
+ * Body param: A brief description of the article
549
+ */
550
+ description?: string;
551
+ /**
552
+ * Body param: Content formatter - "ai" converts markdown/html to Featurebase
553
+ * format using AI
554
+ */
555
+ formatter?: 'default' | 'ai';
556
+ /**
557
+ * Body param: Icon object for the article
558
+ */
559
+ icon?: ArticleIconInputNova | null;
560
+ /**
561
+ * Body param: The ID of the parent collection
562
+ */
563
+ parentId?: string;
564
+ /**
565
+ * Body param: Article state - "live" publishes immediately, "draft" saves as draft
566
+ */
567
+ state?: 'live' | 'draft';
568
+ /**
569
+ * Body param: Dictionary of translations keyed by locale code
570
+ */
571
+ translations?: ArticleCreateParams.Translations;
572
+ /**
573
+ * Header param: API version for this request. Defaults to your organization's
574
+ * configured API version if not specified.
575
+ */
576
+ 'Featurebase-Version'?: string;
577
+ }
578
+ export declare namespace ArticleCreateParams {
579
+ /**
580
+ * Dictionary of translations keyed by locale code
581
+ */
582
+ interface Translations {
583
+ id?: ArticlesAPI.ArticleTranslationInputNova;
584
+ bg?: ArticlesAPI.ArticleTranslationInputNova;
585
+ bn?: ArticlesAPI.ArticleTranslationInputNova;
586
+ bs?: ArticlesAPI.ArticleTranslationInputNova;
587
+ ca?: ArticlesAPI.ArticleTranslationInputNova;
588
+ cs?: ArticlesAPI.ArticleTranslationInputNova;
589
+ da?: ArticlesAPI.ArticleTranslationInputNova;
590
+ de?: ArticlesAPI.ArticleTranslationInputNova;
591
+ el?: ArticlesAPI.ArticleTranslationInputNova;
592
+ en?: ArticlesAPI.ArticleTranslationInputNova;
593
+ es?: ArticlesAPI.ArticleTranslationInputNova;
594
+ et?: ArticlesAPI.ArticleTranslationInputNova;
595
+ fi?: ArticlesAPI.ArticleTranslationInputNova;
596
+ fr?: ArticlesAPI.ArticleTranslationInputNova;
597
+ hi?: ArticlesAPI.ArticleTranslationInputNova;
598
+ hr?: ArticlesAPI.ArticleTranslationInputNova;
599
+ hu?: ArticlesAPI.ArticleTranslationInputNova;
600
+ it?: ArticlesAPI.ArticleTranslationInputNova;
601
+ ja?: ArticlesAPI.ArticleTranslationInputNova;
602
+ ko?: ArticlesAPI.ArticleTranslationInputNova;
603
+ lt?: ArticlesAPI.ArticleTranslationInputNova;
604
+ lv?: ArticlesAPI.ArticleTranslationInputNova;
605
+ mn?: ArticlesAPI.ArticleTranslationInputNova;
606
+ ms?: ArticlesAPI.ArticleTranslationInputNova;
607
+ nb?: ArticlesAPI.ArticleTranslationInputNova;
608
+ nl?: ArticlesAPI.ArticleTranslationInputNova;
609
+ pl?: ArticlesAPI.ArticleTranslationInputNova;
610
+ pt?: ArticlesAPI.ArticleTranslationInputNova;
611
+ 'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
612
+ ro?: ArticlesAPI.ArticleTranslationInputNova;
613
+ ru?: ArticlesAPI.ArticleTranslationInputNova;
614
+ sk?: ArticlesAPI.ArticleTranslationInputNova;
615
+ sl?: ArticlesAPI.ArticleTranslationInputNova;
616
+ sr?: ArticlesAPI.ArticleTranslationInputNova;
617
+ sv?: ArticlesAPI.ArticleTranslationInputNova;
618
+ sw?: ArticlesAPI.ArticleTranslationInputNova;
619
+ th?: ArticlesAPI.ArticleTranslationInputNova;
620
+ tr?: ArticlesAPI.ArticleTranslationInputNova;
621
+ uk?: ArticlesAPI.ArticleTranslationInputNova;
622
+ vi?: ArticlesAPI.ArticleTranslationInputNova;
623
+ 'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
624
+ 'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
625
+ }
626
+ }
627
+ export interface ArticleRetrieveParams {
628
+ /**
629
+ * Query param: Article state to retrieve
630
+ */
631
+ state?: 'live' | 'draft';
632
+ /**
633
+ * Header param: API version for this request. Defaults to your organization's
634
+ * configured API version if not specified.
635
+ */
636
+ 'Featurebase-Version'?: string;
637
+ }
638
+ export interface ArticleUpdateParams {
639
+ /**
640
+ * Body param: ID of the new author (must be a member of the organization)
641
+ */
642
+ authorId?: string;
643
+ /**
644
+ * Body param: The new HTML content of the article
645
+ */
646
+ body?: string;
647
+ /**
648
+ * Body param: The new description of the article
649
+ */
650
+ description?: string;
651
+ /**
652
+ * Body param: Content formatter
653
+ */
654
+ formatter?: 'default' | 'ai';
655
+ /**
656
+ * Body param: Icon object for the article
657
+ */
658
+ icon?: ArticleIconInputNova | null;
659
+ /**
660
+ * Body param: New parent collection ID
661
+ */
662
+ parentId?: string | null;
663
+ /**
664
+ * Body param: Article state - if "live", publishes immediately
665
+ */
666
+ state?: 'live' | 'draft';
667
+ /**
668
+ * Body param: The new title of the article
669
+ */
670
+ title?: string;
671
+ /**
672
+ * Body param: Dictionary of updated translations keyed by locale code
673
+ */
674
+ translations?: ArticleUpdateParams.Translations;
675
+ /**
676
+ * Header param: API version for this request. Defaults to your organization's
677
+ * configured API version if not specified.
678
+ */
679
+ 'Featurebase-Version'?: string;
680
+ }
681
+ export declare namespace ArticleUpdateParams {
682
+ /**
683
+ * Dictionary of updated translations keyed by locale code
684
+ */
685
+ interface Translations {
686
+ id?: ArticlesAPI.ArticleTranslationInputNova;
687
+ bg?: ArticlesAPI.ArticleTranslationInputNova;
688
+ bn?: ArticlesAPI.ArticleTranslationInputNova;
689
+ bs?: ArticlesAPI.ArticleTranslationInputNova;
690
+ ca?: ArticlesAPI.ArticleTranslationInputNova;
691
+ cs?: ArticlesAPI.ArticleTranslationInputNova;
692
+ da?: ArticlesAPI.ArticleTranslationInputNova;
693
+ de?: ArticlesAPI.ArticleTranslationInputNova;
694
+ el?: ArticlesAPI.ArticleTranslationInputNova;
695
+ en?: ArticlesAPI.ArticleTranslationInputNova;
696
+ es?: ArticlesAPI.ArticleTranslationInputNova;
697
+ et?: ArticlesAPI.ArticleTranslationInputNova;
698
+ fi?: ArticlesAPI.ArticleTranslationInputNova;
699
+ fr?: ArticlesAPI.ArticleTranslationInputNova;
700
+ hi?: ArticlesAPI.ArticleTranslationInputNova;
701
+ hr?: ArticlesAPI.ArticleTranslationInputNova;
702
+ hu?: ArticlesAPI.ArticleTranslationInputNova;
703
+ it?: ArticlesAPI.ArticleTranslationInputNova;
704
+ ja?: ArticlesAPI.ArticleTranslationInputNova;
705
+ ko?: ArticlesAPI.ArticleTranslationInputNova;
706
+ lt?: ArticlesAPI.ArticleTranslationInputNova;
707
+ lv?: ArticlesAPI.ArticleTranslationInputNova;
708
+ mn?: ArticlesAPI.ArticleTranslationInputNova;
709
+ ms?: ArticlesAPI.ArticleTranslationInputNova;
710
+ nb?: ArticlesAPI.ArticleTranslationInputNova;
711
+ nl?: ArticlesAPI.ArticleTranslationInputNova;
712
+ pl?: ArticlesAPI.ArticleTranslationInputNova;
713
+ pt?: ArticlesAPI.ArticleTranslationInputNova;
714
+ 'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
715
+ ro?: ArticlesAPI.ArticleTranslationInputNova;
716
+ ru?: ArticlesAPI.ArticleTranslationInputNova;
717
+ sk?: ArticlesAPI.ArticleTranslationInputNova;
718
+ sl?: ArticlesAPI.ArticleTranslationInputNova;
719
+ sr?: ArticlesAPI.ArticleTranslationInputNova;
720
+ sv?: ArticlesAPI.ArticleTranslationInputNova;
721
+ sw?: ArticlesAPI.ArticleTranslationInputNova;
722
+ th?: ArticlesAPI.ArticleTranslationInputNova;
723
+ tr?: ArticlesAPI.ArticleTranslationInputNova;
724
+ uk?: ArticlesAPI.ArticleTranslationInputNova;
725
+ vi?: ArticlesAPI.ArticleTranslationInputNova;
726
+ 'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
727
+ 'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
728
+ }
729
+ }
730
+ export interface ArticleListParams {
731
+ /**
732
+ * Query param: An opaque cursor for pagination. Use the nextCursor value from a
733
+ * previous response to fetch the next page of results.
734
+ */
735
+ cursor?: string;
736
+ /**
737
+ * Query param: Filter articles by help center ID. If omitted, returns articles
738
+ * across all help centers.
739
+ */
740
+ helpCenterId?: string;
741
+ /**
742
+ * Query param: A limit on the number of objects to be returned, between 1 and 100.
743
+ */
744
+ limit?: number;
745
+ /**
746
+ * Query param: Filter articles by parent collection ID
747
+ */
748
+ parentId?: string;
749
+ /**
750
+ * Query param: Filter articles by state. Use "all" to get both draft and live
751
+ * articles.
752
+ */
753
+ state?: 'live' | 'draft' | 'all';
754
+ /**
755
+ * Header param: API version for this request. Defaults to your organization's
756
+ * configured API version if not specified.
757
+ */
758
+ 'Featurebase-Version'?: string;
759
+ }
760
+ export interface ArticleDeleteParams {
761
+ /**
762
+ * API version for this request. Defaults to your organization's configured API
763
+ * version if not specified.
764
+ */
765
+ 'Featurebase-Version'?: string;
766
+ }
767
+ export declare namespace Articles {
768
+ export { type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type ArticleListResponse as ArticleListResponse, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticleCreateParams as ArticleCreateParams, type ArticleRetrieveParams as ArticleRetrieveParams, type ArticleUpdateParams as ArticleUpdateParams, type ArticleListParams as ArticleListParams, type ArticleDeleteParams as ArticleDeleteParams, };
769
+ }
770
+ //# sourceMappingURL=articles.d.mts.map