@foru-ms/sdk 2.1.0 → 2.1.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 (294) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +4 -1
  3. package/dist/cjs/Client.js +16 -11
  4. package/dist/cjs/api/resources/auth/client/Client.d.ts +1 -1
  5. package/dist/cjs/api/resources/auth/client/Client.js +1 -1
  6. package/dist/cjs/api/resources/index.d.ts +3 -0
  7. package/dist/cjs/api/resources/index.js +4 -1
  8. package/dist/cjs/api/resources/integrations/client/Client.d.ts +2 -1
  9. package/dist/cjs/api/resources/integrations/client/Client.js +7 -9
  10. package/dist/cjs/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.ts +8 -2
  11. package/dist/cjs/api/resources/integrations/client/requests/ListIntegrationsRequest.d.ts +2 -2
  12. package/dist/cjs/api/resources/integrations/client/requests/UpdateIntegrationsRequest.d.ts +2 -0
  13. package/dist/cjs/api/resources/integrations/types/UpdateIntegrationsResponse.d.ts +2 -0
  14. package/dist/cjs/api/resources/notifications/client/Client.d.ts +1 -1
  15. package/dist/cjs/api/resources/notifications/client/Client.js +7 -14
  16. package/dist/cjs/api/resources/notifications/client/requests/index.d.ts +2 -2
  17. package/dist/cjs/api/resources/notifications/client/requests/index.js +5 -0
  18. package/dist/cjs/api/resources/posts/client/Client.d.ts +1 -1
  19. package/dist/cjs/api/resources/posts/client/Client.js +22 -49
  20. package/dist/cjs/api/resources/posts/client/requests/index.d.ts +1 -1
  21. package/dist/cjs/api/resources/posts/client/requests/index.js +3 -0
  22. package/dist/cjs/api/resources/privateMessages/client/Client.d.ts +21 -1
  23. package/dist/cjs/api/resources/privateMessages/client/Client.js +79 -18
  24. package/dist/cjs/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.d.ts +16 -0
  25. package/dist/cjs/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.js +3 -0
  26. package/dist/cjs/api/resources/privateMessages/client/requests/index.d.ts +1 -0
  27. package/dist/cjs/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.d.ts +26 -0
  28. package/dist/cjs/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.js +3 -0
  29. package/dist/cjs/api/resources/privateMessages/types/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/privateMessages/types/index.js +1 -0
  31. package/dist/cjs/api/resources/reports/client/Client.d.ts +21 -1
  32. package/dist/cjs/api/resources/reports/client/Client.js +88 -17
  33. package/dist/cjs/api/resources/reports/client/requests/CreateReportsRequest.d.ts +4 -0
  34. package/dist/cjs/api/resources/reports/client/requests/UpdateReportsRequest.d.ts +16 -0
  35. package/dist/cjs/api/resources/reports/client/requests/UpdateReportsRequest.js +3 -0
  36. package/dist/cjs/api/resources/reports/client/requests/index.d.ts +1 -0
  37. package/dist/cjs/api/resources/reports/index.d.ts +1 -0
  38. package/dist/cjs/api/resources/reports/index.js +1 -0
  39. package/dist/cjs/api/resources/reports/types/UpdateReportsResponse.d.ts +30 -0
  40. package/dist/cjs/api/resources/reports/types/UpdateReportsResponse.js +3 -0
  41. package/dist/cjs/api/resources/reports/types/index.d.ts +1 -0
  42. package/dist/cjs/api/resources/reports/types/index.js +17 -0
  43. package/dist/cjs/api/resources/roles/client/Client.d.ts +1 -1
  44. package/dist/cjs/api/resources/roles/client/Client.js +8 -9
  45. package/dist/cjs/api/resources/roles/client/requests/ListRolesRequest.d.ts +7 -2
  46. package/dist/cjs/api/resources/roles/types/ListRolesRequestSort.d.ts +6 -0
  47. package/dist/cjs/api/resources/roles/types/ListRolesRequestSort.js +9 -0
  48. package/dist/cjs/api/resources/roles/types/index.d.ts +1 -0
  49. package/dist/cjs/api/resources/roles/types/index.js +1 -0
  50. package/dist/cjs/api/resources/search/client/Client.d.ts +29 -0
  51. package/dist/cjs/api/resources/search/client/Client.js +115 -0
  52. package/dist/cjs/api/resources/search/client/index.d.ts +1 -0
  53. package/dist/cjs/api/resources/search/client/index.js +2 -0
  54. package/dist/cjs/api/resources/search/index.d.ts +2 -0
  55. package/dist/cjs/api/resources/search/index.js +18 -0
  56. package/dist/cjs/api/resources/search/types/SearchSearchResponse.d.ts +33 -0
  57. package/dist/cjs/api/resources/search/types/SearchSearchResponse.js +22 -0
  58. package/dist/cjs/api/resources/search/types/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/search/types/index.js +17 -0
  60. package/dist/cjs/api/resources/ssOs/client/Client.d.ts +6 -8
  61. package/dist/cjs/api/resources/ssOs/client/Client.js +11 -16
  62. package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.d.ts +24 -15
  63. package/dist/cjs/api/resources/ssOs/client/requests/CreateSsOsRequest.js +10 -0
  64. package/dist/cjs/api/resources/ssOs/client/requests/ListSsOsRequest.d.ts +2 -2
  65. package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.ts +15 -8
  66. package/dist/cjs/api/resources/ssOs/client/requests/UpdateSsOsRequest.js +10 -0
  67. package/dist/cjs/api/resources/ssOs/client/requests/index.d.ts +2 -2
  68. package/dist/cjs/api/resources/ssOs/client/requests/index.js +5 -0
  69. package/dist/cjs/api/resources/ssOs/types/UpdateSsOsResponse.d.ts +2 -0
  70. package/dist/cjs/api/resources/tags/client/Client.d.ts +1 -1
  71. package/dist/cjs/api/resources/tags/client/Client.js +10 -18
  72. package/dist/cjs/api/resources/threads/client/Client.d.ts +1 -1
  73. package/dist/cjs/api/resources/threads/client/Client.js +26 -56
  74. package/dist/cjs/api/resources/threads/client/requests/CreateThreadsRequest.d.ts +6 -0
  75. package/dist/cjs/api/resources/threads/client/requests/index.d.ts +1 -1
  76. package/dist/cjs/api/resources/threads/client/requests/index.js +3 -0
  77. package/dist/cjs/api/resources/threads/types/UpdateThreadsResponse.d.ts +5 -5
  78. package/dist/cjs/api/resources/users/client/Client.d.ts +20 -1
  79. package/dist/cjs/api/resources/users/client/Client.js +80 -28
  80. package/dist/cjs/api/resources/users/client/requests/CreateUsersRequest.d.ts +26 -0
  81. package/dist/cjs/api/resources/users/client/requests/CreateUsersRequest.js +3 -0
  82. package/dist/cjs/api/resources/users/client/requests/index.d.ts +1 -0
  83. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +23 -1
  84. package/dist/cjs/api/resources/webhooks/client/Client.js +91 -15
  85. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhooksRequest.d.ts +4 -0
  86. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhooksRequest.d.ts +22 -0
  87. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhooksRequest.js +3 -0
  88. package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -0
  89. package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponse.d.ts +26 -0
  90. package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponse.js +3 -0
  91. package/dist/cjs/api/resources/webhooks/types/index.d.ts +1 -0
  92. package/dist/cjs/api/resources/webhooks/types/index.js +1 -0
  93. package/dist/cjs/api/types/Integration.d.ts +2 -0
  94. package/dist/cjs/api/types/IntegrationCreate.d.ts +7 -2
  95. package/dist/cjs/api/types/IntegrationList.d.ts +6 -0
  96. package/dist/cjs/api/types/IntegrationList.js +3 -0
  97. package/dist/cjs/api/types/IntegrationListResponse.d.ts +2 -0
  98. package/dist/cjs/api/types/IntegrationResponse.d.ts +2 -0
  99. package/dist/cjs/api/types/IntegrationUpdate.d.ts +2 -0
  100. package/dist/cjs/api/types/MeResponse.d.ts +22 -0
  101. package/dist/cjs/api/types/PrivateMessageUpdate.d.ts +8 -0
  102. package/dist/cjs/api/types/PrivateMessageUpdate.js +3 -0
  103. package/dist/cjs/api/types/Report.d.ts +4 -2
  104. package/dist/cjs/api/types/ReportCreate.d.ts +4 -0
  105. package/dist/cjs/api/types/ReportListResponse.d.ts +4 -2
  106. package/dist/cjs/api/types/ReportResponse.d.ts +4 -2
  107. package/dist/cjs/api/types/ReportUpdate.d.ts +8 -0
  108. package/dist/cjs/api/types/ReportUpdate.js +3 -0
  109. package/dist/cjs/api/types/RoleList.d.ts +19 -0
  110. package/dist/cjs/api/types/RoleList.js +13 -0
  111. package/dist/cjs/api/types/Search.d.ts +1 -0
  112. package/dist/cjs/api/types/Search.js +3 -0
  113. package/dist/cjs/api/types/SearchListResponse.d.ts +18 -0
  114. package/dist/cjs/api/types/SearchListResponse.js +3 -0
  115. package/dist/cjs/api/types/SearchResponse.d.ts +6 -0
  116. package/dist/cjs/api/types/SearchResponse.js +3 -0
  117. package/dist/cjs/api/types/Sso.d.ts +2 -0
  118. package/dist/cjs/api/types/SsoCreate.d.ts +19 -11
  119. package/dist/cjs/api/types/SsoCreate.js +10 -0
  120. package/dist/cjs/api/types/SsoList.d.ts +6 -0
  121. package/dist/cjs/api/types/SsoList.js +3 -0
  122. package/dist/cjs/api/types/SsoListResponse.d.ts +2 -0
  123. package/dist/cjs/api/types/SsoResponse.d.ts +2 -0
  124. package/dist/cjs/api/types/SsoUpdate.d.ts +15 -11
  125. package/dist/cjs/api/types/SsoUpdate.js +10 -0
  126. package/dist/cjs/api/types/Thread.d.ts +5 -5
  127. package/dist/cjs/api/types/ThreadCreate.d.ts +6 -0
  128. package/dist/cjs/api/types/ThreadListResponse.d.ts +5 -5
  129. package/dist/cjs/api/types/ThreadResponse.d.ts +5 -5
  130. package/dist/cjs/api/types/UserCreate.d.ts +20 -0
  131. package/dist/cjs/api/types/UserCreate.js +3 -0
  132. package/dist/cjs/api/types/Webhook.d.ts +2 -0
  133. package/dist/cjs/api/types/WebhookCreate.d.ts +4 -0
  134. package/dist/cjs/api/types/WebhookListResponse.d.ts +2 -0
  135. package/dist/cjs/api/types/WebhookResponse.d.ts +2 -0
  136. package/dist/cjs/api/types/WebhookUpdate.d.ts +14 -0
  137. package/dist/cjs/api/types/WebhookUpdate.js +3 -0
  138. package/dist/cjs/api/types/index.d.ts +10 -0
  139. package/dist/cjs/api/types/index.js +10 -0
  140. package/dist/cjs/auth/HeaderAuthProvider.d.ts +14 -10
  141. package/dist/cjs/auth/HeaderAuthProvider.js +18 -9
  142. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
  143. package/dist/cjs/core/fetcher/Fetcher.d.ts +1 -2
  144. package/dist/cjs/core/headers.d.ts +2 -2
  145. package/dist/cjs/version.d.ts +1 -1
  146. package/dist/cjs/version.js +1 -1
  147. package/dist/esm/BaseClient.mjs +2 -2
  148. package/dist/esm/Client.d.mts +4 -1
  149. package/dist/esm/Client.mjs +6 -1
  150. package/dist/esm/api/resources/auth/client/Client.d.mts +1 -1
  151. package/dist/esm/api/resources/auth/client/Client.mjs +1 -1
  152. package/dist/esm/api/resources/index.d.mts +3 -0
  153. package/dist/esm/api/resources/index.mjs +3 -0
  154. package/dist/esm/api/resources/integrations/client/Client.d.mts +2 -1
  155. package/dist/esm/api/resources/integrations/client/Client.mjs +7 -9
  156. package/dist/esm/api/resources/integrations/client/requests/CreateIntegrationsRequest.d.mts +8 -2
  157. package/dist/esm/api/resources/integrations/client/requests/ListIntegrationsRequest.d.mts +2 -2
  158. package/dist/esm/api/resources/integrations/client/requests/UpdateIntegrationsRequest.d.mts +2 -0
  159. package/dist/esm/api/resources/integrations/types/UpdateIntegrationsResponse.d.mts +2 -0
  160. package/dist/esm/api/resources/notifications/client/Client.d.mts +1 -1
  161. package/dist/esm/api/resources/notifications/client/Client.mjs +7 -14
  162. package/dist/esm/api/resources/notifications/client/requests/index.d.mts +2 -2
  163. package/dist/esm/api/resources/notifications/client/requests/index.mjs +2 -1
  164. package/dist/esm/api/resources/posts/client/Client.d.mts +1 -1
  165. package/dist/esm/api/resources/posts/client/Client.mjs +22 -49
  166. package/dist/esm/api/resources/posts/client/requests/index.d.mts +1 -1
  167. package/dist/esm/api/resources/posts/client/requests/index.mjs +1 -1
  168. package/dist/esm/api/resources/privateMessages/client/Client.d.mts +21 -1
  169. package/dist/esm/api/resources/privateMessages/client/Client.mjs +79 -18
  170. package/dist/esm/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.d.mts +16 -0
  171. package/dist/esm/api/resources/privateMessages/client/requests/UpdatePrivateMessagesRequest.mjs +2 -0
  172. package/dist/esm/api/resources/privateMessages/client/requests/index.d.mts +1 -0
  173. package/dist/esm/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.d.mts +26 -0
  174. package/dist/esm/api/resources/privateMessages/types/UpdatePrivateMessagesResponse.mjs +2 -0
  175. package/dist/esm/api/resources/privateMessages/types/index.d.mts +1 -0
  176. package/dist/esm/api/resources/privateMessages/types/index.mjs +1 -0
  177. package/dist/esm/api/resources/reports/client/Client.d.mts +21 -1
  178. package/dist/esm/api/resources/reports/client/Client.mjs +88 -17
  179. package/dist/esm/api/resources/reports/client/requests/CreateReportsRequest.d.mts +4 -0
  180. package/dist/esm/api/resources/reports/client/requests/UpdateReportsRequest.d.mts +16 -0
  181. package/dist/esm/api/resources/reports/client/requests/UpdateReportsRequest.mjs +2 -0
  182. package/dist/esm/api/resources/reports/client/requests/index.d.mts +1 -0
  183. package/dist/esm/api/resources/reports/index.d.mts +1 -0
  184. package/dist/esm/api/resources/reports/index.mjs +1 -0
  185. package/dist/esm/api/resources/reports/types/UpdateReportsResponse.d.mts +30 -0
  186. package/dist/esm/api/resources/reports/types/UpdateReportsResponse.mjs +2 -0
  187. package/dist/esm/api/resources/reports/types/index.d.mts +1 -0
  188. package/dist/esm/api/resources/reports/types/index.mjs +1 -0
  189. package/dist/esm/api/resources/roles/client/Client.d.mts +1 -1
  190. package/dist/esm/api/resources/roles/client/Client.mjs +8 -9
  191. package/dist/esm/api/resources/roles/client/requests/ListRolesRequest.d.mts +7 -2
  192. package/dist/esm/api/resources/roles/types/ListRolesRequestSort.d.mts +6 -0
  193. package/dist/esm/api/resources/roles/types/ListRolesRequestSort.mjs +6 -0
  194. package/dist/esm/api/resources/roles/types/index.d.mts +1 -0
  195. package/dist/esm/api/resources/roles/types/index.mjs +1 -0
  196. package/dist/esm/api/resources/search/client/Client.d.mts +29 -0
  197. package/dist/esm/api/resources/search/client/Client.mjs +78 -0
  198. package/dist/esm/api/resources/search/client/index.d.mts +1 -0
  199. package/dist/esm/api/resources/search/client/index.mjs +1 -0
  200. package/dist/esm/api/resources/search/index.d.mts +2 -0
  201. package/dist/esm/api/resources/search/index.mjs +2 -0
  202. package/dist/esm/api/resources/search/types/SearchSearchResponse.d.mts +33 -0
  203. package/dist/esm/api/resources/search/types/SearchSearchResponse.mjs +19 -0
  204. package/dist/esm/api/resources/search/types/index.d.mts +1 -0
  205. package/dist/esm/api/resources/search/types/index.mjs +1 -0
  206. package/dist/esm/api/resources/ssOs/client/Client.d.mts +6 -8
  207. package/dist/esm/api/resources/ssOs/client/Client.mjs +11 -16
  208. package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.d.mts +24 -15
  209. package/dist/esm/api/resources/ssOs/client/requests/CreateSsOsRequest.mjs +9 -1
  210. package/dist/esm/api/resources/ssOs/client/requests/ListSsOsRequest.d.mts +2 -2
  211. package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.d.mts +15 -8
  212. package/dist/esm/api/resources/ssOs/client/requests/UpdateSsOsRequest.mjs +9 -1
  213. package/dist/esm/api/resources/ssOs/client/requests/index.d.mts +2 -2
  214. package/dist/esm/api/resources/ssOs/client/requests/index.mjs +2 -1
  215. package/dist/esm/api/resources/ssOs/types/UpdateSsOsResponse.d.mts +2 -0
  216. package/dist/esm/api/resources/tags/client/Client.d.mts +1 -1
  217. package/dist/esm/api/resources/tags/client/Client.mjs +10 -18
  218. package/dist/esm/api/resources/threads/client/Client.d.mts +1 -1
  219. package/dist/esm/api/resources/threads/client/Client.mjs +26 -56
  220. package/dist/esm/api/resources/threads/client/requests/CreateThreadsRequest.d.mts +6 -0
  221. package/dist/esm/api/resources/threads/client/requests/index.d.mts +1 -1
  222. package/dist/esm/api/resources/threads/client/requests/index.mjs +1 -1
  223. package/dist/esm/api/resources/threads/types/UpdateThreadsResponse.d.mts +5 -5
  224. package/dist/esm/api/resources/users/client/Client.d.mts +20 -1
  225. package/dist/esm/api/resources/users/client/Client.mjs +80 -28
  226. package/dist/esm/api/resources/users/client/requests/CreateUsersRequest.d.mts +26 -0
  227. package/dist/esm/api/resources/users/client/requests/CreateUsersRequest.mjs +2 -0
  228. package/dist/esm/api/resources/users/client/requests/index.d.mts +1 -0
  229. package/dist/esm/api/resources/webhooks/client/Client.d.mts +23 -1
  230. package/dist/esm/api/resources/webhooks/client/Client.mjs +91 -15
  231. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhooksRequest.d.mts +4 -0
  232. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhooksRequest.d.mts +22 -0
  233. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhooksRequest.mjs +2 -0
  234. package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -0
  235. package/dist/esm/api/resources/webhooks/types/UpdateWebhooksResponse.d.mts +26 -0
  236. package/dist/esm/api/resources/webhooks/types/UpdateWebhooksResponse.mjs +2 -0
  237. package/dist/esm/api/resources/webhooks/types/index.d.mts +1 -0
  238. package/dist/esm/api/resources/webhooks/types/index.mjs +1 -0
  239. package/dist/esm/api/types/Integration.d.mts +2 -0
  240. package/dist/esm/api/types/IntegrationCreate.d.mts +7 -2
  241. package/dist/esm/api/types/IntegrationList.d.mts +6 -0
  242. package/dist/esm/api/types/IntegrationList.mjs +2 -0
  243. package/dist/esm/api/types/IntegrationListResponse.d.mts +2 -0
  244. package/dist/esm/api/types/IntegrationResponse.d.mts +2 -0
  245. package/dist/esm/api/types/IntegrationUpdate.d.mts +2 -0
  246. package/dist/esm/api/types/MeResponse.d.mts +22 -0
  247. package/dist/esm/api/types/PrivateMessageUpdate.d.mts +8 -0
  248. package/dist/esm/api/types/PrivateMessageUpdate.mjs +2 -0
  249. package/dist/esm/api/types/Report.d.mts +4 -2
  250. package/dist/esm/api/types/ReportCreate.d.mts +4 -0
  251. package/dist/esm/api/types/ReportListResponse.d.mts +4 -2
  252. package/dist/esm/api/types/ReportResponse.d.mts +4 -2
  253. package/dist/esm/api/types/ReportUpdate.d.mts +8 -0
  254. package/dist/esm/api/types/ReportUpdate.mjs +2 -0
  255. package/dist/esm/api/types/RoleList.d.mts +19 -0
  256. package/dist/esm/api/types/RoleList.mjs +10 -0
  257. package/dist/esm/api/types/Search.d.mts +1 -0
  258. package/dist/esm/api/types/Search.mjs +2 -0
  259. package/dist/esm/api/types/SearchListResponse.d.mts +18 -0
  260. package/dist/esm/api/types/SearchListResponse.mjs +2 -0
  261. package/dist/esm/api/types/SearchResponse.d.mts +6 -0
  262. package/dist/esm/api/types/SearchResponse.mjs +2 -0
  263. package/dist/esm/api/types/Sso.d.mts +2 -0
  264. package/dist/esm/api/types/SsoCreate.d.mts +19 -11
  265. package/dist/esm/api/types/SsoCreate.mjs +9 -1
  266. package/dist/esm/api/types/SsoList.d.mts +6 -0
  267. package/dist/esm/api/types/SsoList.mjs +2 -0
  268. package/dist/esm/api/types/SsoListResponse.d.mts +2 -0
  269. package/dist/esm/api/types/SsoResponse.d.mts +2 -0
  270. package/dist/esm/api/types/SsoUpdate.d.mts +15 -11
  271. package/dist/esm/api/types/SsoUpdate.mjs +9 -1
  272. package/dist/esm/api/types/Thread.d.mts +5 -5
  273. package/dist/esm/api/types/ThreadCreate.d.mts +6 -0
  274. package/dist/esm/api/types/ThreadListResponse.d.mts +5 -5
  275. package/dist/esm/api/types/ThreadResponse.d.mts +5 -5
  276. package/dist/esm/api/types/UserCreate.d.mts +20 -0
  277. package/dist/esm/api/types/UserCreate.mjs +2 -0
  278. package/dist/esm/api/types/Webhook.d.mts +2 -0
  279. package/dist/esm/api/types/WebhookCreate.d.mts +4 -0
  280. package/dist/esm/api/types/WebhookListResponse.d.mts +2 -0
  281. package/dist/esm/api/types/WebhookResponse.d.mts +2 -0
  282. package/dist/esm/api/types/WebhookUpdate.d.mts +14 -0
  283. package/dist/esm/api/types/WebhookUpdate.mjs +2 -0
  284. package/dist/esm/api/types/index.d.mts +10 -0
  285. package/dist/esm/api/types/index.mjs +10 -0
  286. package/dist/esm/auth/HeaderAuthProvider.d.mts +14 -10
  287. package/dist/esm/auth/HeaderAuthProvider.mjs +18 -9
  288. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
  289. package/dist/esm/core/fetcher/Fetcher.d.mts +1 -2
  290. package/dist/esm/core/headers.d.mts +2 -2
  291. package/dist/esm/version.d.mts +1 -1
  292. package/dist/esm/version.mjs +1 -1
  293. package/package.json +2 -2
  294. package/reference.md +310 -7
@@ -10,21 +10,21 @@ export interface Thread {
10
10
  tags?: string[];
11
11
  /** Poll data */
12
12
  poll?: Forum.ThreadPoll;
13
- id: string;
14
- /** URL-friendly identifier */
15
- slug: string | null;
16
13
  /** Whether thread is locked */
17
14
  locked: boolean | null;
18
15
  /** Whether thread is pinned */
19
16
  pinned: boolean | null;
17
+ /** Custom metadata */
18
+ extendedData: Record<string, unknown> | null;
19
+ id: string;
20
+ /** URL-friendly identifier */
21
+ slug: string | null;
20
22
  /** View count */
21
23
  views: number;
22
24
  /** Number of posts/replies */
23
25
  postsCount: number;
24
26
  /** Timestamp of the last post */
25
27
  lastPostAt: string | null;
26
- /** Custom metadata */
27
- extendedData: Record<string, unknown> | null;
28
28
  createdAt: string;
29
29
  updatedAt: string;
30
30
  }
@@ -9,6 +9,12 @@ export interface ThreadCreate {
9
9
  tags?: string[];
10
10
  /** Poll data */
11
11
  poll?: ThreadCreate.Poll;
12
+ /** Lock thread on creation */
13
+ locked?: boolean;
14
+ /** Pin thread on creation */
15
+ pinned?: boolean;
16
+ /** Custom extended data */
17
+ extendedData?: Record<string, unknown>;
12
18
  }
13
19
  export declare namespace ThreadCreate {
14
20
  /**
@@ -23,21 +23,21 @@ export declare namespace ThreadListResponse {
23
23
  tags?: string[];
24
24
  /** Poll data */
25
25
  poll?: Item.Poll;
26
- id: string;
27
- /** URL-friendly identifier */
28
- slug: string | null;
29
26
  /** Whether thread is locked */
30
27
  locked: boolean | null;
31
28
  /** Whether thread is pinned */
32
29
  pinned: boolean | null;
30
+ /** Custom metadata */
31
+ extendedData: Record<string, unknown> | null;
32
+ id: string;
33
+ /** URL-friendly identifier */
34
+ slug: string | null;
33
35
  /** View count */
34
36
  views: number;
35
37
  /** Number of posts/replies */
36
38
  postsCount: number;
37
39
  /** Timestamp of the last post */
38
40
  lastPostAt: string | null;
39
- /** Custom metadata */
40
- extendedData: Record<string, unknown> | null;
41
41
  createdAt: string;
42
42
  updatedAt: string;
43
43
  }
@@ -13,21 +13,21 @@ export declare namespace ThreadResponse {
13
13
  tags?: string[];
14
14
  /** Poll data */
15
15
  poll?: Data.Poll;
16
- id: string;
17
- /** URL-friendly identifier */
18
- slug: string | null;
19
16
  /** Whether thread is locked */
20
17
  locked: boolean | null;
21
18
  /** Whether thread is pinned */
22
19
  pinned: boolean | null;
20
+ /** Custom metadata */
21
+ extendedData: Record<string, unknown> | null;
22
+ id: string;
23
+ /** URL-friendly identifier */
24
+ slug: string | null;
23
25
  /** View count */
24
26
  views: number;
25
27
  /** Number of posts/replies */
26
28
  postsCount: number;
27
29
  /** Timestamp of the last post */
28
30
  lastPostAt: string | null;
29
- /** Custom metadata */
30
- extendedData: Record<string, unknown> | null;
31
31
  createdAt: string;
32
32
  updatedAt: string;
33
33
  }
@@ -0,0 +1,20 @@
1
+ export interface UserCreate {
2
+ /** Username (letters, numbers, underscores, hyphens) */
3
+ username: string;
4
+ /** Email address */
5
+ email?: string;
6
+ /** Password (min 8 chars) */
7
+ password?: string;
8
+ /** Display name */
9
+ displayName?: string;
10
+ /** User bio */
11
+ bio?: string;
12
+ /** Forum signature */
13
+ signature?: string;
14
+ /** Website URL */
15
+ url?: string;
16
+ /** Role slugs to assign */
17
+ roles?: string[];
18
+ /** Custom extended data */
19
+ extendedData?: Record<string, unknown>;
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -8,6 +8,8 @@ export interface Webhook {
8
8
  events: string[];
9
9
  /** Whether webhook is active */
10
10
  active: boolean;
11
+ /** Custom extended data */
12
+ extendedData: Record<string, unknown> | null;
11
13
  /** Last trigger timestamp */
12
14
  lastTriggered: string | null;
13
15
  /** Consecutive failure count */
@@ -7,4 +7,8 @@ export interface WebhookCreate {
7
7
  events: string[];
8
8
  /** Secret for signature verification (auto-generated if missing) */
9
9
  secret?: string;
10
+ /** Whether webhook is active */
11
+ active?: boolean;
12
+ /** Custom extended data */
13
+ extendedData?: Record<string, unknown>;
10
14
  }
@@ -22,6 +22,8 @@ export declare namespace WebhookListResponse {
22
22
  events: string[];
23
23
  /** Whether webhook is active */
24
24
  active: boolean;
25
+ /** Custom extended data */
26
+ extendedData: Record<string, unknown> | null;
25
27
  /** Last trigger timestamp */
26
28
  lastTriggered: string | null;
27
29
  /** Consecutive failure count */
@@ -12,6 +12,8 @@ export declare namespace WebhookResponse {
12
12
  events: string[];
13
13
  /** Whether webhook is active */
14
14
  active: boolean;
15
+ /** Custom extended data */
16
+ extendedData: Record<string, unknown> | null;
15
17
  /** Last trigger timestamp */
16
18
  lastTriggered: string | null;
17
19
  /** Consecutive failure count */
@@ -0,0 +1,14 @@
1
+ export interface WebhookUpdate {
2
+ /** Webhook name */
3
+ name?: string;
4
+ /** Target URL */
5
+ url?: string;
6
+ /** Event types to trigger on */
7
+ events?: string[];
8
+ /** New secret */
9
+ secret?: string;
10
+ /** Enable/disable webhook */
11
+ active?: boolean;
12
+ /** Custom extended data */
13
+ extendedData?: Record<string, unknown>;
14
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -5,6 +5,7 @@ export * from "./ErrorResponse.mjs";
5
5
  export * from "./ForgotPasswordResponse.mjs";
6
6
  export * from "./Integration.mjs";
7
7
  export * from "./IntegrationCreate.mjs";
8
+ export * from "./IntegrationList.mjs";
8
9
  export * from "./IntegrationListResponse.mjs";
9
10
  export * from "./IntegrationResponse.mjs";
10
11
  export * from "./IntegrationUpdate.mjs";
@@ -38,20 +39,27 @@ export * from "./PrivateMessageReplyCreate.mjs";
38
39
  export * from "./PrivateMessageReplyListResponse.mjs";
39
40
  export * from "./PrivateMessageReplyResponse.mjs";
40
41
  export * from "./PrivateMessageResponse.mjs";
42
+ export * from "./PrivateMessageUpdate.mjs";
41
43
  export * from "./RegisterResponse.mjs";
42
44
  export * from "./Report.mjs";
43
45
  export * from "./ReportCreate.mjs";
44
46
  export * from "./ReportList.mjs";
45
47
  export * from "./ReportListResponse.mjs";
46
48
  export * from "./ReportResponse.mjs";
49
+ export * from "./ReportUpdate.mjs";
47
50
  export * from "./ResetPasswordResponse.mjs";
48
51
  export * from "./Role.mjs";
49
52
  export * from "./RoleCreate.mjs";
53
+ export * from "./RoleList.mjs";
50
54
  export * from "./RoleListResponse.mjs";
51
55
  export * from "./RoleResponse.mjs";
52
56
  export * from "./RoleUpdate.mjs";
57
+ export * from "./Search.mjs";
58
+ export * from "./SearchListResponse.mjs";
59
+ export * from "./SearchResponse.mjs";
53
60
  export * from "./Sso.mjs";
54
61
  export * from "./SsoCreate.mjs";
62
+ export * from "./SsoList.mjs";
55
63
  export * from "./SsoListResponse.mjs";
56
64
  export * from "./SsoResponse.mjs";
57
65
  export * from "./SsoUpdate.mjs";
@@ -86,6 +94,7 @@ export * from "./ThreadSubscriberListResponse.mjs";
86
94
  export * from "./ThreadSubscriberResponse.mjs";
87
95
  export * from "./ThreadUpdate.mjs";
88
96
  export * from "./User.mjs";
97
+ export * from "./UserCreate.mjs";
89
98
  export * from "./UserFollower.mjs";
90
99
  export * from "./UserFollowerListResponse.mjs";
91
100
  export * from "./UserFollowerResponse.mjs";
@@ -104,3 +113,4 @@ export * from "./WebhookDeliveryResponse.mjs";
104
113
  export * from "./WebhookList.mjs";
105
114
  export * from "./WebhookListResponse.mjs";
106
115
  export * from "./WebhookResponse.mjs";
116
+ export * from "./WebhookUpdate.mjs";
@@ -5,6 +5,7 @@ export * from "./ErrorResponse.mjs";
5
5
  export * from "./ForgotPasswordResponse.mjs";
6
6
  export * from "./Integration.mjs";
7
7
  export * from "./IntegrationCreate.mjs";
8
+ export * from "./IntegrationList.mjs";
8
9
  export * from "./IntegrationListResponse.mjs";
9
10
  export * from "./IntegrationResponse.mjs";
10
11
  export * from "./IntegrationUpdate.mjs";
@@ -38,20 +39,27 @@ export * from "./PrivateMessageReplyCreate.mjs";
38
39
  export * from "./PrivateMessageReplyListResponse.mjs";
39
40
  export * from "./PrivateMessageReplyResponse.mjs";
40
41
  export * from "./PrivateMessageResponse.mjs";
42
+ export * from "./PrivateMessageUpdate.mjs";
41
43
  export * from "./RegisterResponse.mjs";
42
44
  export * from "./Report.mjs";
43
45
  export * from "./ReportCreate.mjs";
44
46
  export * from "./ReportList.mjs";
45
47
  export * from "./ReportListResponse.mjs";
46
48
  export * from "./ReportResponse.mjs";
49
+ export * from "./ReportUpdate.mjs";
47
50
  export * from "./ResetPasswordResponse.mjs";
48
51
  export * from "./Role.mjs";
49
52
  export * from "./RoleCreate.mjs";
53
+ export * from "./RoleList.mjs";
50
54
  export * from "./RoleListResponse.mjs";
51
55
  export * from "./RoleResponse.mjs";
52
56
  export * from "./RoleUpdate.mjs";
57
+ export * from "./Search.mjs";
58
+ export * from "./SearchListResponse.mjs";
59
+ export * from "./SearchResponse.mjs";
53
60
  export * from "./Sso.mjs";
54
61
  export * from "./SsoCreate.mjs";
62
+ export * from "./SsoList.mjs";
55
63
  export * from "./SsoListResponse.mjs";
56
64
  export * from "./SsoResponse.mjs";
57
65
  export * from "./SsoUpdate.mjs";
@@ -86,6 +94,7 @@ export * from "./ThreadSubscriberListResponse.mjs";
86
94
  export * from "./ThreadSubscriberResponse.mjs";
87
95
  export * from "./ThreadUpdate.mjs";
88
96
  export * from "./User.mjs";
97
+ export * from "./UserCreate.mjs";
89
98
  export * from "./UserFollower.mjs";
90
99
  export * from "./UserFollowerListResponse.mjs";
91
100
  export * from "./UserFollowerResponse.mjs";
@@ -104,3 +113,4 @@ export * from "./WebhookDeliveryResponse.mjs";
104
113
  export * from "./WebhookList.mjs";
105
114
  export * from "./WebhookListResponse.mjs";
106
115
  export * from "./WebhookResponse.mjs";
116
+ export * from "./WebhookUpdate.mjs";
@@ -1,16 +1,20 @@
1
1
  import * as core from "../core/index.mjs";
2
- export declare namespace HeaderAuthProvider {
3
- interface AuthOptions {
4
- apiKey: core.Supplier<string>;
5
- }
6
- interface Options extends AuthOptions {
7
- }
8
- }
2
+ declare const PARAM_KEY: "apiKey";
9
3
  export declare class HeaderAuthProvider implements core.AuthProvider {
10
- private readonly headerValue;
4
+ private readonly options;
11
5
  constructor(options: HeaderAuthProvider.Options);
12
- static canCreate(options: HeaderAuthProvider.Options): boolean;
13
- getAuthRequest(_arg?: {
6
+ static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
7
+ getAuthRequest({ endpointMetadata, }?: {
14
8
  endpointMetadata?: core.EndpointMetadata;
15
9
  }): Promise<core.AuthRequest>;
16
10
  }
11
+ export declare namespace HeaderAuthProvider {
12
+ const AUTH_SCHEME: "ApiKeyAuth";
13
+ const AUTH_CONFIG_ERROR_MESSAGE: string;
14
+ type Options = AuthOptions;
15
+ type AuthOptions = {
16
+ [PARAM_KEY]?: core.Supplier<string>;
17
+ };
18
+ function createInstance(options: Options): core.AuthProvider;
19
+ }
20
+ export {};
@@ -10,25 +10,34 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  import * as core from "../core/index.mjs";
12
12
  import * as errors from "../errors/index.mjs";
13
+ const PARAM_KEY = "apiKey";
14
+ const HEADER_NAME = "x-api-key";
13
15
  export class HeaderAuthProvider {
14
16
  constructor(options) {
15
- this.headerValue = options.apiKey;
17
+ this.options = options;
16
18
  }
17
19
  static canCreate(options) {
18
- return options.apiKey != null;
20
+ return (options === null || options === void 0 ? void 0 : options[PARAM_KEY]) != null;
19
21
  }
20
- getAuthRequest(_arg) {
21
- return __awaiter(this, void 0, void 0, function* () {
22
- const apiKey = yield core.Supplier.get(this.headerValue);
23
- if (apiKey == null) {
22
+ getAuthRequest() {
23
+ return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
24
+ const headerValue = yield core.Supplier.get(this.options[PARAM_KEY]);
25
+ if (headerValue == null) {
24
26
  throw new errors.ForumError({
25
- message: "Please specify a apiKey by passing it in to the constructor",
27
+ message: HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
26
28
  });
27
29
  }
28
- const headerValue = apiKey;
29
30
  return {
30
- headers: { "x-api-key": headerValue },
31
+ headers: { [HEADER_NAME]: headerValue },
31
32
  };
32
33
  });
33
34
  }
34
35
  }
36
+ (function (HeaderAuthProvider) {
37
+ HeaderAuthProvider.AUTH_SCHEME = "ApiKeyAuth";
38
+ HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${PARAM_KEY}' when initializing the client`;
39
+ function createInstance(options) {
40
+ return new HeaderAuthProvider(options);
41
+ }
42
+ HeaderAuthProvider.createInstance = createInstance;
43
+ })(HeaderAuthProvider || (HeaderAuthProvider = {}));
@@ -1,12 +1,12 @@
1
1
  import type { EndpointMetadata } from "./EndpointMetadata.mjs";
2
2
  import type { Supplier } from "./Supplier.mjs";
3
3
  type EndpointSupplierFn<T> = (arg: {
4
- endpointMetadata: EndpointMetadata;
4
+ endpointMetadata?: EndpointMetadata;
5
5
  }) => T | Promise<T>;
6
6
  export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
7
7
  export declare const EndpointSupplier: {
8
8
  get: <T>(supplier: EndpointSupplier<T>, arg: {
9
- endpointMetadata: EndpointMetadata;
9
+ endpointMetadata?: EndpointMetadata;
10
10
  }) => Promise<T>;
11
11
  };
12
12
  export {};
@@ -1,14 +1,13 @@
1
1
  import { type LogConfig, type Logger } from "../logging/logger.mjs";
2
2
  import type { APIResponse } from "./APIResponse.mjs";
3
3
  import type { EndpointMetadata } from "./EndpointMetadata.mjs";
4
- import { EndpointSupplier } from "./EndpointSupplier.mjs";
5
4
  export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
6
5
  export declare namespace Fetcher {
7
6
  interface Args {
8
7
  url: string;
9
8
  method: string;
10
9
  contentType?: string;
11
- headers?: Record<string, string | EndpointSupplier<string | null | undefined> | null | undefined>;
10
+ headers?: Record<string, unknown>;
12
11
  queryParameters?: Record<string, unknown>;
13
12
  body?: unknown;
14
13
  timeoutMs?: number;
@@ -1,2 +1,2 @@
1
- export declare function mergeHeaders<THeaderValue>(...headersArray: (Record<string, THeaderValue> | null | undefined)[]): Record<string, string | THeaderValue>;
2
- export declare function mergeOnlyDefinedHeaders<THeaderValue>(...headersArray: (Record<string, THeaderValue> | null | undefined)[]): Record<string, THeaderValue>;
1
+ export declare function mergeHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
2
+ export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.0.9";
1
+ export declare const SDK_VERSION = "2.1.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "2.0.9";
1
+ export const SDK_VERSION = "2.1.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@foru-ms/sdk",
3
- "version": "2.1.0",
3
+ "version": "2.1.2",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -51,7 +51,7 @@
51
51
  "vitest": "^3.2.4",
52
52
  "@types/node": "^18.19.70",
53
53
  "typescript": "~5.7.2",
54
- "@biomejs/biome": "2.3.1"
54
+ "@biomejs/biome": "2.3.11"
55
55
  },
56
56
  "browser": {
57
57
  "fs": false,