featurebase-node 0.14.3 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (362) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/client.d.mts +5 -5
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +5 -5
  5. package/client.d.ts.map +1 -1
  6. package/package.json +1 -1
  7. package/resources/audit-logs.d.mts +3 -3
  8. package/resources/audit-logs.d.mts.map +1 -1
  9. package/resources/audit-logs.d.ts +3 -3
  10. package/resources/audit-logs.d.ts.map +1 -1
  11. package/resources/changelogs/changelogs.d.mts +116 -116
  12. package/resources/changelogs/changelogs.d.mts.map +1 -1
  13. package/resources/changelogs/changelogs.d.ts +116 -116
  14. package/resources/changelogs/changelogs.d.ts.map +1 -1
  15. package/resources/changelogs/changelogs.js +74 -74
  16. package/resources/changelogs/changelogs.js.map +1 -1
  17. package/resources/changelogs/changelogs.mjs +74 -74
  18. package/resources/changelogs/changelogs.mjs.map +1 -1
  19. package/resources/changelogs/index.d.mts +1 -1
  20. package/resources/changelogs/index.d.mts.map +1 -1
  21. package/resources/changelogs/index.d.ts +1 -1
  22. package/resources/changelogs/index.d.ts.map +1 -1
  23. package/resources/changelogs/subscribers.d.mts +3 -3
  24. package/resources/changelogs/subscribers.d.mts.map +1 -1
  25. package/resources/changelogs/subscribers.d.ts +3 -3
  26. package/resources/changelogs/subscribers.d.ts.map +1 -1
  27. package/resources/conversation-attributes.d.mts +17 -17
  28. package/resources/conversation-attributes.d.mts.map +1 -1
  29. package/resources/conversation-attributes.d.ts +17 -17
  30. package/resources/conversation-attributes.d.ts.map +1 -1
  31. package/resources/conversation-attributes.js +19 -19
  32. package/resources/conversation-attributes.js.map +1 -1
  33. package/resources/conversation-attributes.mjs +19 -19
  34. package/resources/conversation-attributes.mjs.map +1 -1
  35. package/resources/feedback/boards.d.mts +19 -19
  36. package/resources/feedback/boards.d.mts.map +1 -1
  37. package/resources/feedback/boards.d.ts +19 -19
  38. package/resources/feedback/boards.d.ts.map +1 -1
  39. package/resources/feedback/boards.js +20 -20
  40. package/resources/feedback/boards.js.map +1 -1
  41. package/resources/feedback/boards.mjs +20 -20
  42. package/resources/feedback/boards.mjs.map +1 -1
  43. package/resources/feedback/comments.d.mts +113 -113
  44. package/resources/feedback/comments.d.mts.map +1 -1
  45. package/resources/feedback/comments.d.ts +113 -113
  46. package/resources/feedback/comments.d.ts.map +1 -1
  47. package/resources/feedback/comments.js +93 -93
  48. package/resources/feedback/comments.js.map +1 -1
  49. package/resources/feedback/comments.mjs +93 -93
  50. package/resources/feedback/comments.mjs.map +1 -1
  51. package/resources/feedback/custom-fields.d.mts +36 -36
  52. package/resources/feedback/custom-fields.d.mts.map +1 -1
  53. package/resources/feedback/custom-fields.d.ts +36 -36
  54. package/resources/feedback/custom-fields.d.ts.map +1 -1
  55. package/resources/feedback/custom-fields.js +36 -36
  56. package/resources/feedback/custom-fields.js.map +1 -1
  57. package/resources/feedback/custom-fields.mjs +36 -36
  58. package/resources/feedback/custom-fields.mjs.map +1 -1
  59. package/resources/feedback/feedback.d.mts +5 -5
  60. package/resources/feedback/feedback.d.mts.map +1 -1
  61. package/resources/feedback/feedback.d.ts +5 -5
  62. package/resources/feedback/feedback.d.ts.map +1 -1
  63. package/resources/feedback/index.d.mts +5 -5
  64. package/resources/feedback/index.d.mts.map +1 -1
  65. package/resources/feedback/index.d.ts +5 -5
  66. package/resources/feedback/index.d.ts.map +1 -1
  67. package/resources/feedback/post-statuses.d.mts +20 -20
  68. package/resources/feedback/post-statuses.d.mts.map +1 -1
  69. package/resources/feedback/post-statuses.d.ts +20 -20
  70. package/resources/feedback/post-statuses.d.ts.map +1 -1
  71. package/resources/feedback/post-statuses.js +23 -23
  72. package/resources/feedback/post-statuses.js.map +1 -1
  73. package/resources/feedback/post-statuses.mjs +23 -23
  74. package/resources/feedback/post-statuses.mjs.map +1 -1
  75. package/resources/feedback/posts/index.d.mts +1 -1
  76. package/resources/feedback/posts/index.d.mts.map +1 -1
  77. package/resources/feedback/posts/index.d.ts +1 -1
  78. package/resources/feedback/posts/index.d.ts.map +1 -1
  79. package/resources/feedback/posts/posts.d.mts +132 -132
  80. package/resources/feedback/posts/posts.d.mts.map +1 -1
  81. package/resources/feedback/posts/posts.d.ts +132 -132
  82. package/resources/feedback/posts/posts.d.ts.map +1 -1
  83. package/resources/feedback/posts/posts.js +107 -107
  84. package/resources/feedback/posts/posts.js.map +1 -1
  85. package/resources/feedback/posts/posts.mjs +107 -107
  86. package/resources/feedback/posts/posts.mjs.map +1 -1
  87. package/resources/feedback/posts/voters.d.mts +3 -3
  88. package/resources/feedback/posts/voters.d.mts.map +1 -1
  89. package/resources/feedback/posts/voters.d.ts +3 -3
  90. package/resources/feedback/posts/voters.d.ts.map +1 -1
  91. package/resources/help-center/articles.d.mts +213 -97
  92. package/resources/help-center/articles.d.mts.map +1 -1
  93. package/resources/help-center/articles.d.ts +213 -97
  94. package/resources/help-center/articles.d.ts.map +1 -1
  95. package/resources/help-center/articles.js +73 -73
  96. package/resources/help-center/articles.js.map +1 -1
  97. package/resources/help-center/articles.mjs +73 -73
  98. package/resources/help-center/articles.mjs.map +1 -1
  99. package/resources/help-center/collections.d.mts +158 -71
  100. package/resources/help-center/collections.d.mts.map +1 -1
  101. package/resources/help-center/collections.d.ts +158 -71
  102. package/resources/help-center/collections.d.ts.map +1 -1
  103. package/resources/help-center/collections.js +65 -65
  104. package/resources/help-center/collections.js.map +1 -1
  105. package/resources/help-center/collections.mjs +65 -65
  106. package/resources/help-center/collections.mjs.map +1 -1
  107. package/resources/help-center/help-center.d.mts +4 -4
  108. package/resources/help-center/help-center.d.mts.map +1 -1
  109. package/resources/help-center/help-center.d.ts +4 -4
  110. package/resources/help-center/help-center.d.ts.map +1 -1
  111. package/resources/help-center/help-centers.d.mts +77 -48
  112. package/resources/help-center/help-centers.d.mts.map +1 -1
  113. package/resources/help-center/help-centers.d.ts +77 -48
  114. package/resources/help-center/help-centers.d.ts.map +1 -1
  115. package/resources/help-center/help-centers.js +43 -43
  116. package/resources/help-center/help-centers.js.map +1 -1
  117. package/resources/help-center/help-centers.mjs +43 -43
  118. package/resources/help-center/help-centers.mjs.map +1 -1
  119. package/resources/help-center/index.d.mts +4 -4
  120. package/resources/help-center/index.d.mts.map +1 -1
  121. package/resources/help-center/index.d.ts +4 -4
  122. package/resources/help-center/index.d.ts.map +1 -1
  123. package/resources/help-center/redirect-rules.d.mts +124 -124
  124. package/resources/help-center/redirect-rules.d.mts.map +1 -1
  125. package/resources/help-center/redirect-rules.d.ts +124 -124
  126. package/resources/help-center/redirect-rules.d.ts.map +1 -1
  127. package/resources/help-center/redirect-rules.js +112 -112
  128. package/resources/help-center/redirect-rules.js.map +1 -1
  129. package/resources/help-center/redirect-rules.mjs +112 -112
  130. package/resources/help-center/redirect-rules.mjs.map +1 -1
  131. package/resources/index.d.mts +5 -5
  132. package/resources/index.d.mts.map +1 -1
  133. package/resources/index.d.ts +5 -5
  134. package/resources/index.d.ts.map +1 -1
  135. package/resources/organization/admins.d.mts +26 -26
  136. package/resources/organization/admins.d.mts.map +1 -1
  137. package/resources/organization/admins.d.ts +26 -26
  138. package/resources/organization/admins.d.ts.map +1 -1
  139. package/resources/organization/admins.js +25 -25
  140. package/resources/organization/admins.js.map +1 -1
  141. package/resources/organization/admins.mjs +25 -25
  142. package/resources/organization/admins.mjs.map +1 -1
  143. package/resources/organization/brands.d.mts +52 -52
  144. package/resources/organization/brands.d.mts.map +1 -1
  145. package/resources/organization/brands.d.ts +52 -52
  146. package/resources/organization/brands.d.ts.map +1 -1
  147. package/resources/organization/brands.js +54 -54
  148. package/resources/organization/brands.js.map +1 -1
  149. package/resources/organization/brands.mjs +54 -54
  150. package/resources/organization/brands.mjs.map +1 -1
  151. package/resources/organization/index.d.mts +3 -3
  152. package/resources/organization/index.d.mts.map +1 -1
  153. package/resources/organization/index.d.ts +3 -3
  154. package/resources/organization/index.d.ts.map +1 -1
  155. package/resources/organization/organization.d.mts +3 -3
  156. package/resources/organization/organization.d.mts.map +1 -1
  157. package/resources/organization/organization.d.ts +3 -3
  158. package/resources/organization/organization.d.ts.map +1 -1
  159. package/resources/organization/teams.d.mts +47 -47
  160. package/resources/organization/teams.d.mts.map +1 -1
  161. package/resources/organization/teams.d.ts +47 -47
  162. package/resources/organization/teams.d.ts.map +1 -1
  163. package/resources/organization/teams.js +44 -44
  164. package/resources/organization/teams.js.map +1 -1
  165. package/resources/organization/teams.mjs +44 -44
  166. package/resources/organization/teams.mjs.map +1 -1
  167. package/resources/reports.d.mts +249 -215
  168. package/resources/reports.d.mts.map +1 -1
  169. package/resources/reports.d.ts +249 -215
  170. package/resources/reports.d.ts.map +1 -1
  171. package/resources/reports.js +99 -99
  172. package/resources/reports.js.map +1 -1
  173. package/resources/reports.mjs +99 -99
  174. package/resources/reports.mjs.map +1 -1
  175. package/resources/support/conversation-tags.d.mts +43 -43
  176. package/resources/support/conversation-tags.d.mts.map +1 -1
  177. package/resources/support/conversation-tags.d.ts +43 -43
  178. package/resources/support/conversation-tags.d.ts.map +1 -1
  179. package/resources/support/conversation-tags.js +32 -32
  180. package/resources/support/conversation-tags.js.map +1 -1
  181. package/resources/support/conversation-tags.mjs +32 -32
  182. package/resources/support/conversation-tags.mjs.map +1 -1
  183. package/resources/support/conversations/conversations.d.mts +337 -327
  184. package/resources/support/conversations/conversations.d.mts.map +1 -1
  185. package/resources/support/conversations/conversations.d.ts +337 -327
  186. package/resources/support/conversations/conversations.d.ts.map +1 -1
  187. package/resources/support/conversations/conversations.js +293 -283
  188. package/resources/support/conversations/conversations.js.map +1 -1
  189. package/resources/support/conversations/conversations.mjs +293 -283
  190. package/resources/support/conversations/conversations.mjs.map +1 -1
  191. package/resources/support/conversations/index.d.mts +1 -1
  192. package/resources/support/conversations/index.d.mts.map +1 -1
  193. package/resources/support/conversations/index.d.ts +1 -1
  194. package/resources/support/conversations/index.d.ts.map +1 -1
  195. package/resources/support/conversations/participants.d.mts +2 -2
  196. package/resources/support/conversations/participants.d.mts.map +1 -1
  197. package/resources/support/conversations/participants.d.ts +2 -2
  198. package/resources/support/conversations/participants.d.ts.map +1 -1
  199. package/resources/support/index.d.mts +3 -3
  200. package/resources/support/index.d.mts.map +1 -1
  201. package/resources/support/index.d.ts +3 -3
  202. package/resources/support/index.d.ts.map +1 -1
  203. package/resources/support/support.d.mts +3 -3
  204. package/resources/support/support.d.mts.map +1 -1
  205. package/resources/support/support.d.ts +3 -3
  206. package/resources/support/support.d.ts.map +1 -1
  207. package/resources/support/tickets/categories.d.mts +20 -20
  208. package/resources/support/tickets/categories.d.mts.map +1 -1
  209. package/resources/support/tickets/categories.d.ts +20 -20
  210. package/resources/support/tickets/categories.d.ts.map +1 -1
  211. package/resources/support/tickets/categories.js +25 -25
  212. package/resources/support/tickets/categories.js.map +1 -1
  213. package/resources/support/tickets/categories.mjs +25 -25
  214. package/resources/support/tickets/categories.mjs.map +1 -1
  215. package/resources/support/tickets/custom-fields.d.mts +22 -22
  216. package/resources/support/tickets/custom-fields.d.mts.map +1 -1
  217. package/resources/support/tickets/custom-fields.d.ts +22 -22
  218. package/resources/support/tickets/custom-fields.d.ts.map +1 -1
  219. package/resources/support/tickets/custom-fields.js +19 -19
  220. package/resources/support/tickets/custom-fields.js.map +1 -1
  221. package/resources/support/tickets/custom-fields.mjs +19 -19
  222. package/resources/support/tickets/custom-fields.mjs.map +1 -1
  223. package/resources/support/tickets/index.d.mts +4 -4
  224. package/resources/support/tickets/index.d.mts.map +1 -1
  225. package/resources/support/tickets/index.d.ts +4 -4
  226. package/resources/support/tickets/index.d.ts.map +1 -1
  227. package/resources/support/tickets/statuses.d.mts +19 -19
  228. package/resources/support/tickets/statuses.d.mts.map +1 -1
  229. package/resources/support/tickets/statuses.d.ts +19 -19
  230. package/resources/support/tickets/statuses.d.ts.map +1 -1
  231. package/resources/support/tickets/statuses.js +21 -21
  232. package/resources/support/tickets/statuses.js.map +1 -1
  233. package/resources/support/tickets/statuses.mjs +21 -21
  234. package/resources/support/tickets/statuses.mjs.map +1 -1
  235. package/resources/support/tickets/tickets.d.mts +75 -75
  236. package/resources/support/tickets/tickets.d.mts.map +1 -1
  237. package/resources/support/tickets/tickets.d.ts +75 -75
  238. package/resources/support/tickets/tickets.d.ts.map +1 -1
  239. package/resources/support/tickets/tickets.js +44 -44
  240. package/resources/support/tickets/tickets.js.map +1 -1
  241. package/resources/support/tickets/tickets.mjs +44 -44
  242. package/resources/support/tickets/tickets.mjs.map +1 -1
  243. package/resources/surveys.d.mts +43 -43
  244. package/resources/surveys.d.mts.map +1 -1
  245. package/resources/surveys.d.ts +43 -43
  246. package/resources/surveys.d.ts.map +1 -1
  247. package/resources/surveys.js +44 -44
  248. package/resources/surveys.js.map +1 -1
  249. package/resources/surveys.mjs +44 -44
  250. package/resources/surveys.mjs.map +1 -1
  251. package/resources/users/companies/companies.d.mts +121 -130
  252. package/resources/users/companies/companies.d.mts.map +1 -1
  253. package/resources/users/companies/companies.d.ts +121 -130
  254. package/resources/users/companies/companies.d.ts.map +1 -1
  255. package/resources/users/companies/companies.js +125 -125
  256. package/resources/users/companies/companies.js.map +1 -1
  257. package/resources/users/companies/companies.mjs +125 -125
  258. package/resources/users/companies/companies.mjs.map +1 -1
  259. package/resources/users/companies/contacts.d.mts +3 -3
  260. package/resources/users/companies/contacts.d.mts.map +1 -1
  261. package/resources/users/companies/contacts.d.ts +3 -3
  262. package/resources/users/companies/contacts.d.ts.map +1 -1
  263. package/resources/users/companies/index.d.mts +1 -1
  264. package/resources/users/companies/index.d.mts.map +1 -1
  265. package/resources/users/companies/index.d.ts +1 -1
  266. package/resources/users/companies/index.d.ts.map +1 -1
  267. package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
  268. package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
  269. package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
  270. package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
  271. package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
  272. package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
  273. package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
  274. package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
  275. package/resources/users/contacts/contacts.d.mts +249 -235
  276. package/resources/users/contacts/contacts.d.mts.map +1 -1
  277. package/resources/users/contacts/contacts.d.ts +249 -235
  278. package/resources/users/contacts/contacts.d.ts.map +1 -1
  279. package/resources/users/contacts/contacts.js +211 -184
  280. package/resources/users/contacts/contacts.js.map +1 -1
  281. package/resources/users/contacts/contacts.mjs +211 -184
  282. package/resources/users/contacts/contacts.mjs.map +1 -1
  283. package/resources/users/contacts/email-preferences.d.mts +2 -2
  284. package/resources/users/contacts/email-preferences.d.mts.map +1 -1
  285. package/resources/users/contacts/email-preferences.d.ts +2 -2
  286. package/resources/users/contacts/email-preferences.d.ts.map +1 -1
  287. package/resources/users/contacts/index.d.mts +1 -1
  288. package/resources/users/contacts/index.d.mts.map +1 -1
  289. package/resources/users/contacts/index.d.ts +1 -1
  290. package/resources/users/contacts/index.d.ts.map +1 -1
  291. package/resources/users/index.d.mts +2 -2
  292. package/resources/users/index.d.mts.map +1 -1
  293. package/resources/users/index.d.ts +2 -2
  294. package/resources/users/index.d.ts.map +1 -1
  295. package/resources/users/users.d.mts +2 -2
  296. package/resources/users/users.d.mts.map +1 -1
  297. package/resources/users/users.d.ts +2 -2
  298. package/resources/users/users.d.ts.map +1 -1
  299. package/resources/webhooks.d.mts +83 -83
  300. package/resources/webhooks.d.mts.map +1 -1
  301. package/resources/webhooks.d.ts +83 -83
  302. package/resources/webhooks.d.ts.map +1 -1
  303. package/resources/webhooks.js +77 -77
  304. package/resources/webhooks.js.map +1 -1
  305. package/resources/webhooks.mjs +77 -77
  306. package/resources/webhooks.mjs.map +1 -1
  307. package/src/client.ts +6 -6
  308. package/src/resources/audit-logs.ts +7 -1
  309. package/src/resources/changelogs/changelogs.ts +320 -175
  310. package/src/resources/changelogs/index.ts +1 -1
  311. package/src/resources/changelogs/subscribers.ts +31 -2
  312. package/src/resources/conversation-attributes.ts +34 -34
  313. package/src/resources/feedback/boards.ts +30 -30
  314. package/src/resources/feedback/comments.ts +137 -137
  315. package/src/resources/feedback/custom-fields.ts +46 -46
  316. package/src/resources/feedback/feedback.ts +6 -6
  317. package/src/resources/feedback/index.ts +6 -6
  318. package/src/resources/feedback/post-statuses.ts +33 -33
  319. package/src/resources/feedback/posts/index.ts +2 -2
  320. package/src/resources/feedback/posts/posts.ts +176 -176
  321. package/src/resources/feedback/posts/voters.ts +3 -3
  322. package/src/resources/help-center/articles.ts +631 -109
  323. package/src/resources/help-center/collections.ts +349 -88
  324. package/src/resources/help-center/help-center.ts +5 -5
  325. package/src/resources/help-center/help-centers.ts +202 -57
  326. package/src/resources/help-center/index.ts +5 -5
  327. package/src/resources/help-center/redirect-rules.ts +294 -178
  328. package/src/resources/index.ts +6 -6
  329. package/src/resources/organization/admins.ts +36 -36
  330. package/src/resources/organization/brands.ts +68 -68
  331. package/src/resources/organization/index.ts +3 -3
  332. package/src/resources/organization/organization.ts +3 -3
  333. package/src/resources/organization/teams.ts +54 -54
  334. package/src/resources/reports.ts +311 -262
  335. package/src/resources/support/conversation-tags.ts +62 -62
  336. package/src/resources/support/conversations/conversations.ts +429 -419
  337. package/src/resources/support/conversations/index.ts +4 -4
  338. package/src/resources/support/conversations/participants.ts +2 -2
  339. package/src/resources/support/index.ts +7 -7
  340. package/src/resources/support/support.ts +7 -7
  341. package/src/resources/support/tickets/categories.ts +35 -35
  342. package/src/resources/support/tickets/custom-fields.ts +29 -29
  343. package/src/resources/support/tickets/index.ts +4 -4
  344. package/src/resources/support/tickets/statuses.ts +31 -31
  345. package/src/resources/support/tickets/tickets.ts +101 -101
  346. package/src/resources/surveys.ts +60 -60
  347. package/src/resources/users/companies/companies.ts +158 -172
  348. package/src/resources/users/companies/contacts.ts +3 -3
  349. package/src/resources/users/companies/index.ts +2 -2
  350. package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
  351. package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
  352. package/src/resources/users/contacts/contacts.ts +284 -280
  353. package/src/resources/users/contacts/email-preferences.ts +2 -2
  354. package/src/resources/users/contacts/index.ts +3 -3
  355. package/src/resources/users/index.ts +5 -5
  356. package/src/resources/users/users.ts +5 -5
  357. package/src/resources/webhooks.ts +106 -100
  358. package/src/version.ts +1 -1
  359. package/version.d.mts +1 -1
  360. package/version.d.ts +1 -1
  361. package/version.js +1 -1
  362. package/version.mjs +1 -1
@@ -6,51 +6,6 @@ import { RequestOptions } from "../../internal/request-options.js";
6
6
  * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
7
7
  */
8
8
  export declare class RedirectRules extends APIResource {
9
- /**
10
- * Returns a paginated list of redirect rules within your organization.
11
- *
12
- * Redirect rules map old Help Center URLs to new article or collection
13
- * destinations, enabling seamless migration from legacy help center systems. Only
14
- * Help Centers with a custom domain configured support redirect rules.
15
- *
16
- * ### Query Parameters
17
- *
18
- * - `limit` - Number of items to return (1-100, default 10)
19
- * - `cursor` - Cursor for pagination
20
- * - `helpCenterId` - Filter by help center ID
21
- * - `locale` - Filter by locale code
22
- * - `targetType` - Filter by target type ("article" or "collection")
23
- *
24
- * ### Response Format
25
- *
26
- * Returns a list object with:
27
- *
28
- * - `object` - Always "list"
29
- * - `data` - Array of redirect rule objects
30
- * - `nextCursor` - Cursor for next page (null if no more results)
31
- *
32
- * ### Redirect Rule Object
33
- *
34
- * Each redirect rule includes:
35
- *
36
- * - `id` - Unique identifier (MongoDB ObjectId)
37
- * - `helpCenterId` - Help center this rule belongs to
38
- * - `locale` - Locale code used to resolve the target translation
39
- * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
40
- * - `targetType` - "article" or "collection"
41
- * - `targetId` - ID of the target article or collection
42
- * - `createdAt` - ISO 8601 timestamp when created
43
- * - `updatedAt` - ISO 8601 timestamp when last updated
44
- *
45
- * @example
46
- * ```ts
47
- * // Automatically fetches more pages as needed.
48
- * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
49
- * // ...
50
- * }
51
- * ```
52
- */
53
- list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
54
9
  /**
55
10
  * Creates a new redirect rule in your organization.
56
11
  *
@@ -95,45 +50,6 @@ export declare class RedirectRules extends APIResource {
95
50
  * ```
96
51
  */
97
52
  create(params: RedirectRuleCreateParams, options?: RequestOptions): APIPromise<RedirectRule>;
98
- /**
99
- * Retrieves a specific redirect rule by its source URL.
100
- *
101
- * The `url` query parameter is normalized before matching: query parameters and
102
- * hash fragments are stripped, the hostname is lowercased, and trailing slashes
103
- * are removed. This is the same normalization applied when creating a redirect
104
- * rule.
105
- *
106
- * ### Query Parameters
107
- *
108
- * - `url` (required) - Full absolute URL to look up (http or https)
109
- *
110
- * ### Response
111
- *
112
- * Returns a redirect rule object with:
113
- *
114
- * - `id` - Unique identifier (MongoDB ObjectId)
115
- * - `helpCenterId` - Help center this rule belongs to
116
- * - `locale` - Locale code
117
- * - `fromUrl` - Canonical source URL being redirected from
118
- * - `targetType` - "article" or "collection"
119
- * - `targetId` - ID of the target article or collection
120
- * - `createdAt` - ISO 8601 timestamp when created
121
- * - `updatedAt` - ISO 8601 timestamp when last updated
122
- *
123
- * ### Errors
124
- *
125
- * - `400` - Invalid URL format
126
- * - `404` - No redirect rule exists for the given URL
127
- *
128
- * @example
129
- * ```ts
130
- * const redirectRule =
131
- * await client.helpCenter.redirectRules.retrieveByURL({
132
- * url: 'https://help.example.com/en/old/getting-started',
133
- * });
134
- * ```
135
- */
136
- retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
137
53
  /**
138
54
  * Retrieves a specific redirect rule by its unique identifier.
139
55
  *
@@ -204,6 +120,51 @@ export declare class RedirectRules extends APIResource {
204
120
  * ```
205
121
  */
206
122
  update(id: string, params: RedirectRuleUpdateParams, options?: RequestOptions): APIPromise<RedirectRule>;
123
+ /**
124
+ * Returns a paginated list of redirect rules within your organization.
125
+ *
126
+ * Redirect rules map old Help Center URLs to new article or collection
127
+ * destinations, enabling seamless migration from legacy help center systems. Only
128
+ * Help Centers with a custom domain configured support redirect rules.
129
+ *
130
+ * ### Query Parameters
131
+ *
132
+ * - `limit` - Number of items to return (1-100, default 10)
133
+ * - `cursor` - Cursor for pagination
134
+ * - `helpCenterId` - Filter by help center ID
135
+ * - `locale` - Filter by locale code
136
+ * - `targetType` - Filter by target type ("article" or "collection")
137
+ *
138
+ * ### Response Format
139
+ *
140
+ * Returns a list object with:
141
+ *
142
+ * - `object` - Always "list"
143
+ * - `data` - Array of redirect rule objects
144
+ * - `nextCursor` - Cursor for next page (null if no more results)
145
+ *
146
+ * ### Redirect Rule Object
147
+ *
148
+ * Each redirect rule includes:
149
+ *
150
+ * - `id` - Unique identifier (MongoDB ObjectId)
151
+ * - `helpCenterId` - Help center this rule belongs to
152
+ * - `locale` - Locale code used to resolve the target translation
153
+ * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
154
+ * - `targetType` - "article" or "collection"
155
+ * - `targetId` - ID of the target article or collection
156
+ * - `createdAt` - ISO 8601 timestamp when created
157
+ * - `updatedAt` - ISO 8601 timestamp when last updated
158
+ *
159
+ * @example
160
+ * ```ts
161
+ * // Automatically fetches more pages as needed.
162
+ * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
163
+ * // ...
164
+ * }
165
+ * ```
166
+ */
167
+ list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
207
168
  /**
208
169
  * Deletes an existing redirect rule. The associated Redis cache entry is also
209
170
  * invalidated.
@@ -233,6 +194,45 @@ export declare class RedirectRules extends APIResource {
233
194
  * ```
234
195
  */
235
196
  delete(id: string, params?: RedirectRuleDeleteParams | null | undefined, options?: RequestOptions): APIPromise<RedirectRuleDeleteResponse>;
197
+ /**
198
+ * Retrieves a specific redirect rule by its source URL.
199
+ *
200
+ * The `url` query parameter is normalized before matching: query parameters and
201
+ * hash fragments are stripped, the hostname is lowercased, and trailing slashes
202
+ * are removed. This is the same normalization applied when creating a redirect
203
+ * rule.
204
+ *
205
+ * ### Query Parameters
206
+ *
207
+ * - `url` (required) - Full absolute URL to look up (http or https)
208
+ *
209
+ * ### Response
210
+ *
211
+ * Returns a redirect rule object with:
212
+ *
213
+ * - `id` - Unique identifier (MongoDB ObjectId)
214
+ * - `helpCenterId` - Help center this rule belongs to
215
+ * - `locale` - Locale code
216
+ * - `fromUrl` - Canonical source URL being redirected from
217
+ * - `targetType` - "article" or "collection"
218
+ * - `targetId` - ID of the target article or collection
219
+ * - `createdAt` - ISO 8601 timestamp when created
220
+ * - `updatedAt` - ISO 8601 timestamp when last updated
221
+ *
222
+ * ### Errors
223
+ *
224
+ * - `400` - Invalid URL format
225
+ * - `404` - No redirect rule exists for the given URL
226
+ *
227
+ * @example
228
+ * ```ts
229
+ * const redirectRule =
230
+ * await client.helpCenter.redirectRules.retrieveByURL({
231
+ * url: 'https://help.example.com/en/old/getting-started',
232
+ * });
233
+ * ```
234
+ */
235
+ retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
236
236
  }
237
237
  export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
238
238
  export interface RedirectRule {
@@ -255,7 +255,7 @@ export interface RedirectRule {
255
255
  /**
256
256
  * Locale code for the redirect rule
257
257
  */
258
- 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';
258
+ locale: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | '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';
259
259
  /**
260
260
  * Object type identifier
261
261
  */
@@ -287,25 +287,6 @@ export interface RedirectRuleDeleteResponse {
287
287
  */
288
288
  object: 'redirect_rule';
289
289
  }
290
- export interface RedirectRuleListParams extends CursorPageParams {
291
- /**
292
- * Query param: Filter redirect rules by help center ID
293
- */
294
- helpCenterId?: string;
295
- /**
296
- * Query param: Filter redirect rules by locale
297
- */
298
- 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';
299
- /**
300
- * Query param: Filter redirect rules by target type
301
- */
302
- targetType?: 'article' | 'collection';
303
- /**
304
- * Header param: API version for this request. Defaults to your organization's
305
- * configured API version if not specified.
306
- */
307
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
308
- }
309
290
  export interface RedirectRuleCreateParams {
310
291
  /**
311
292
  * Body param: Full absolute URL to redirect from. Must use http or https protocol.
@@ -321,7 +302,7 @@ export interface RedirectRuleCreateParams {
321
302
  * Body param: Locale code for the redirect rule. Used to resolve the target
322
303
  * article/collection translation.
323
304
  */
324
- 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';
305
+ locale: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | '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';
325
306
  /**
326
307
  * Body param: ID of the target article or collection
327
308
  */
@@ -334,27 +315,14 @@ export interface RedirectRuleCreateParams {
334
315
  * Header param: API version for this request. Defaults to your organization's
335
316
  * configured API version if not specified.
336
317
  */
337
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
338
- }
339
- export interface RedirectRuleRetrieveByURLParams {
340
- /**
341
- * Query param: Full absolute URL to look up. The URL is normalized before
342
- * matching: query parameters and hash fragments are stripped, the hostname is
343
- * lowercased, and trailing slashes are removed.
344
- */
345
- url: string;
346
- /**
347
- * Header param: API version for this request. Defaults to your organization's
348
- * configured API version if not specified.
349
- */
350
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
318
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
351
319
  }
352
320
  export interface RedirectRuleRetrieveParams {
353
321
  /**
354
322
  * API version for this request. Defaults to your organization's configured API
355
323
  * version if not specified.
356
324
  */
357
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
325
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
358
326
  }
359
327
  export interface RedirectRuleUpdateParams {
360
328
  /**
@@ -370,7 +338,7 @@ export interface RedirectRuleUpdateParams {
370
338
  /**
371
339
  * Body param: Locale code for the redirect rule
372
340
  */
373
- 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';
341
+ locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | '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';
374
342
  /**
375
343
  * Body param: ID of the target article or collection
376
344
  */
@@ -383,16 +351,48 @@ export interface RedirectRuleUpdateParams {
383
351
  * Header param: API version for this request. Defaults to your organization's
384
352
  * configured API version if not specified.
385
353
  */
386
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
354
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
355
+ }
356
+ export interface RedirectRuleListParams extends CursorPageParams {
357
+ /**
358
+ * Query param: Filter redirect rules by help center ID
359
+ */
360
+ helpCenterId?: string;
361
+ /**
362
+ * Query param: Filter redirect rules by locale
363
+ */
364
+ locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | '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';
365
+ /**
366
+ * Query param: Filter redirect rules by target type
367
+ */
368
+ targetType?: 'article' | 'collection';
369
+ /**
370
+ * Header param: API version for this request. Defaults to your organization's
371
+ * configured API version if not specified.
372
+ */
373
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
387
374
  }
388
375
  export interface RedirectRuleDeleteParams {
389
376
  /**
390
377
  * API version for this request. Defaults to your organization's configured API
391
378
  * version if not specified.
392
379
  */
393
- 'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
380
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
381
+ }
382
+ export interface RedirectRuleRetrieveByURLParams {
383
+ /**
384
+ * Query param: Full absolute URL to look up. The URL is normalized before
385
+ * matching: query parameters and hash fragments are stripped, the hostname is
386
+ * lowercased, and trailing slashes are removed.
387
+ */
388
+ url: string;
389
+ /**
390
+ * Header param: API version for this request. Defaults to your organization's
391
+ * configured API version if not specified.
392
+ */
393
+ 'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
394
394
  }
395
395
  export declare namespace RedirectRules {
396
- export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, };
396
+ export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
397
397
  }
398
398
  //# sourceMappingURL=redirect-rules.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,iCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgBxG;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAc1C;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,iCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgBxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAe3G;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
@@ -10,65 +10,6 @@ const path_1 = require("../../internal/utils/path.js");
10
10
  * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
11
11
  */
12
12
  class RedirectRules extends resource_1.APIResource {
13
- /**
14
- * Returns a paginated list of redirect rules within your organization.
15
- *
16
- * Redirect rules map old Help Center URLs to new article or collection
17
- * destinations, enabling seamless migration from legacy help center systems. Only
18
- * Help Centers with a custom domain configured support redirect rules.
19
- *
20
- * ### Query Parameters
21
- *
22
- * - `limit` - Number of items to return (1-100, default 10)
23
- * - `cursor` - Cursor for pagination
24
- * - `helpCenterId` - Filter by help center ID
25
- * - `locale` - Filter by locale code
26
- * - `targetType` - Filter by target type ("article" or "collection")
27
- *
28
- * ### Response Format
29
- *
30
- * Returns a list object with:
31
- *
32
- * - `object` - Always "list"
33
- * - `data` - Array of redirect rule objects
34
- * - `nextCursor` - Cursor for next page (null if no more results)
35
- *
36
- * ### Redirect Rule Object
37
- *
38
- * Each redirect rule includes:
39
- *
40
- * - `id` - Unique identifier (MongoDB ObjectId)
41
- * - `helpCenterId` - Help center this rule belongs to
42
- * - `locale` - Locale code used to resolve the target translation
43
- * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
44
- * - `targetType` - "article" or "collection"
45
- * - `targetId` - ID of the target article or collection
46
- * - `createdAt` - ISO 8601 timestamp when created
47
- * - `updatedAt` - ISO 8601 timestamp when last updated
48
- *
49
- * @example
50
- * ```ts
51
- * // Automatically fetches more pages as needed.
52
- * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
53
- * // ...
54
- * }
55
- * ```
56
- */
57
- list(params = {}, options) {
58
- const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
59
- return this._client.getAPIList('/v2/help_center/redirect_rules', (pagination_1.CursorPage), {
60
- query,
61
- ...options,
62
- headers: (0, headers_1.buildHeaders)([
63
- {
64
- ...(featurebaseVersion?.toString() != null ?
65
- { 'Featurebase-Version': featurebaseVersion?.toString() }
66
- : undefined),
67
- },
68
- options?.headers,
69
- ]),
70
- });
71
- }
72
13
  /**
73
14
  * Creates a new redirect rule in your organization.
74
15
  *
@@ -127,59 +68,6 @@ class RedirectRules extends resource_1.APIResource {
127
68
  ]),
128
69
  });
129
70
  }
130
- /**
131
- * Retrieves a specific redirect rule by its source URL.
132
- *
133
- * The `url` query parameter is normalized before matching: query parameters and
134
- * hash fragments are stripped, the hostname is lowercased, and trailing slashes
135
- * are removed. This is the same normalization applied when creating a redirect
136
- * rule.
137
- *
138
- * ### Query Parameters
139
- *
140
- * - `url` (required) - Full absolute URL to look up (http or https)
141
- *
142
- * ### Response
143
- *
144
- * Returns a redirect rule object with:
145
- *
146
- * - `id` - Unique identifier (MongoDB ObjectId)
147
- * - `helpCenterId` - Help center this rule belongs to
148
- * - `locale` - Locale code
149
- * - `fromUrl` - Canonical source URL being redirected from
150
- * - `targetType` - "article" or "collection"
151
- * - `targetId` - ID of the target article or collection
152
- * - `createdAt` - ISO 8601 timestamp when created
153
- * - `updatedAt` - ISO 8601 timestamp when last updated
154
- *
155
- * ### Errors
156
- *
157
- * - `400` - Invalid URL format
158
- * - `404` - No redirect rule exists for the given URL
159
- *
160
- * @example
161
- * ```ts
162
- * const redirectRule =
163
- * await client.helpCenter.redirectRules.retrieveByURL({
164
- * url: 'https://help.example.com/en/old/getting-started',
165
- * });
166
- * ```
167
- */
168
- retrieveByURL(params, options) {
169
- const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
170
- return this._client.get('/v2/help_center/redirect_rules/by-url', {
171
- query,
172
- ...options,
173
- headers: (0, headers_1.buildHeaders)([
174
- {
175
- ...(featurebaseVersion?.toString() != null ?
176
- { 'Featurebase-Version': featurebaseVersion?.toString() }
177
- : undefined),
178
- },
179
- options?.headers,
180
- ]),
181
- });
182
- }
183
71
  /**
184
72
  * Retrieves a specific redirect rule by its unique identifier.
185
73
  *
@@ -277,6 +165,65 @@ class RedirectRules extends resource_1.APIResource {
277
165
  ]),
278
166
  });
279
167
  }
168
+ /**
169
+ * Returns a paginated list of redirect rules within your organization.
170
+ *
171
+ * Redirect rules map old Help Center URLs to new article or collection
172
+ * destinations, enabling seamless migration from legacy help center systems. Only
173
+ * Help Centers with a custom domain configured support redirect rules.
174
+ *
175
+ * ### Query Parameters
176
+ *
177
+ * - `limit` - Number of items to return (1-100, default 10)
178
+ * - `cursor` - Cursor for pagination
179
+ * - `helpCenterId` - Filter by help center ID
180
+ * - `locale` - Filter by locale code
181
+ * - `targetType` - Filter by target type ("article" or "collection")
182
+ *
183
+ * ### Response Format
184
+ *
185
+ * Returns a list object with:
186
+ *
187
+ * - `object` - Always "list"
188
+ * - `data` - Array of redirect rule objects
189
+ * - `nextCursor` - Cursor for next page (null if no more results)
190
+ *
191
+ * ### Redirect Rule Object
192
+ *
193
+ * Each redirect rule includes:
194
+ *
195
+ * - `id` - Unique identifier (MongoDB ObjectId)
196
+ * - `helpCenterId` - Help center this rule belongs to
197
+ * - `locale` - Locale code used to resolve the target translation
198
+ * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
199
+ * - `targetType` - "article" or "collection"
200
+ * - `targetId` - ID of the target article or collection
201
+ * - `createdAt` - ISO 8601 timestamp when created
202
+ * - `updatedAt` - ISO 8601 timestamp when last updated
203
+ *
204
+ * @example
205
+ * ```ts
206
+ * // Automatically fetches more pages as needed.
207
+ * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
208
+ * // ...
209
+ * }
210
+ * ```
211
+ */
212
+ list(params = {}, options) {
213
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
214
+ return this._client.getAPIList('/v2/help_center/redirect_rules', (pagination_1.CursorPage), {
215
+ query,
216
+ ...options,
217
+ headers: (0, headers_1.buildHeaders)([
218
+ {
219
+ ...(featurebaseVersion?.toString() != null ?
220
+ { 'Featurebase-Version': featurebaseVersion?.toString() }
221
+ : undefined),
222
+ },
223
+ options?.headers,
224
+ ]),
225
+ });
226
+ }
280
227
  /**
281
228
  * Deletes an existing redirect rule. The associated Redis cache entry is also
282
229
  * invalidated.
@@ -319,6 +266,59 @@ class RedirectRules extends resource_1.APIResource {
319
266
  ]),
320
267
  });
321
268
  }
269
+ /**
270
+ * Retrieves a specific redirect rule by its source URL.
271
+ *
272
+ * The `url` query parameter is normalized before matching: query parameters and
273
+ * hash fragments are stripped, the hostname is lowercased, and trailing slashes
274
+ * are removed. This is the same normalization applied when creating a redirect
275
+ * rule.
276
+ *
277
+ * ### Query Parameters
278
+ *
279
+ * - `url` (required) - Full absolute URL to look up (http or https)
280
+ *
281
+ * ### Response
282
+ *
283
+ * Returns a redirect rule object with:
284
+ *
285
+ * - `id` - Unique identifier (MongoDB ObjectId)
286
+ * - `helpCenterId` - Help center this rule belongs to
287
+ * - `locale` - Locale code
288
+ * - `fromUrl` - Canonical source URL being redirected from
289
+ * - `targetType` - "article" or "collection"
290
+ * - `targetId` - ID of the target article or collection
291
+ * - `createdAt` - ISO 8601 timestamp when created
292
+ * - `updatedAt` - ISO 8601 timestamp when last updated
293
+ *
294
+ * ### Errors
295
+ *
296
+ * - `400` - Invalid URL format
297
+ * - `404` - No redirect rule exists for the given URL
298
+ *
299
+ * @example
300
+ * ```ts
301
+ * const redirectRule =
302
+ * await client.helpCenter.redirectRules.retrieveByURL({
303
+ * url: 'https://help.example.com/en/old/getting-started',
304
+ * });
305
+ * ```
306
+ */
307
+ retrieveByURL(params, options) {
308
+ const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
309
+ return this._client.get('/v2/help_center/redirect_rules/by-url', {
310
+ query,
311
+ ...options,
312
+ headers: (0, headers_1.buildHeaders)([
313
+ {
314
+ ...(featurebaseVersion?.toString() != null ?
315
+ { 'Featurebase-Version': featurebaseVersion?.toString() }
316
+ : undefined),
317
+ },
318
+ options?.headers,
319
+ ]),
320
+ });
321
+ }
322
322
  }
323
323
  exports.RedirectRules = RedirectRules;
324
324
  //# sourceMappingURL=redirect-rules.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"redirect-rules.js","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gCAAgC,EAAE,CAAA,uBAAwB,CAAA,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAtUD,sCAsUC"}
1
+ {"version":3,"file":"redirect-rules.js","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gCAAgC,EAAE,CAAA,uBAAwB,CAAA,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAtUD,sCAsUC"}