@fern-api/venus-api-sdk 0.22.4 → 0.22.34

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 (305) hide show
  1. package/README.md +270 -0
  2. package/dist/cjs/BaseClient.d.ts +17 -4
  3. package/dist/cjs/BaseClient.js +59 -0
  4. package/dist/cjs/Client.d.ts +19 -16
  5. package/dist/cjs/Client.js +15 -50
  6. package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +16 -17
  7. package/dist/cjs/api/resources/apiKeys/client/Client.js +41 -34
  8. package/dist/cjs/api/resources/apiKeys/client/create.js +1 -1
  9. package/dist/cjs/api/resources/apiKeys/client/getTokenMetadata.js +1 -1
  10. package/dist/cjs/api/resources/apiKeys/client/getTokensForOrganization.js +1 -1
  11. package/dist/cjs/api/resources/apiKeys/client/revokeToken.js +1 -1
  12. package/dist/cjs/api/resources/apiKeys/client/revokeTokenById.js +1 -1
  13. package/dist/cjs/api/resources/auth/client/Client.d.ts +69 -0
  14. package/dist/cjs/api/resources/auth/client/Client.js +295 -0
  15. package/dist/cjs/api/resources/auth/client/getAutopilotToken.d.ts +24 -0
  16. package/dist/cjs/api/resources/auth/client/getAutopilotToken.js +65 -0
  17. package/dist/cjs/api/resources/auth/client/getJwt.d.ts +24 -0
  18. package/dist/cjs/api/resources/auth/client/getJwt.js +65 -0
  19. package/dist/cjs/api/resources/auth/client/getOrgForGithubOwner.d.ts +19 -0
  20. package/dist/cjs/api/resources/auth/client/getOrgForGithubOwner.js +55 -0
  21. package/dist/cjs/api/resources/auth/client/index.d.ts +4 -0
  22. package/dist/cjs/api/resources/auth/client/index.js +43 -0
  23. package/dist/cjs/api/resources/auth/client/requests/GetAutopilotTokenRequest.d.ts +22 -0
  24. package/dist/cjs/api/resources/auth/client/requests/GetAutopilotTokenRequest.js +3 -0
  25. package/dist/cjs/api/resources/auth/client/requests/GetJwtRequest.d.ts +16 -0
  26. package/dist/cjs/api/resources/auth/client/requests/GetJwtRequest.js +3 -0
  27. package/dist/cjs/api/resources/auth/client/requests/index.d.ts +2 -0
  28. package/dist/cjs/api/resources/auth/client/requests/index.js +2 -0
  29. package/dist/cjs/api/resources/auth/index.d.ts +2 -0
  30. package/dist/cjs/api/resources/auth/index.js +18 -0
  31. package/dist/cjs/api/resources/auth/types/JwtResponse.d.ts +11 -0
  32. package/dist/cjs/api/resources/auth/types/JwtResponse.js +3 -0
  33. package/dist/cjs/api/resources/auth/types/index.d.ts +1 -0
  34. package/dist/cjs/api/resources/auth/types/index.js +17 -0
  35. package/dist/cjs/api/resources/index.d.ts +3 -0
  36. package/dist/cjs/api/resources/index.js +4 -1
  37. package/dist/cjs/api/resources/organization/client/Client.d.ts +37 -27
  38. package/dist/cjs/api/resources/organization/client/Client.js +152 -60
  39. package/dist/cjs/api/resources/organization/client/addUser.js +1 -1
  40. package/dist/cjs/api/resources/organization/client/create.js +1 -1
  41. package/dist/cjs/api/resources/organization/client/delete.js +1 -1
  42. package/dist/cjs/api/resources/organization/client/get.js +1 -1
  43. package/dist/cjs/api/resources/organization/client/getByPostmanTeamId.d.ts +24 -0
  44. package/dist/cjs/api/resources/organization/client/getByPostmanTeamId.js +65 -0
  45. package/dist/cjs/api/resources/organization/client/getMyOrganizationFromScopedToken.js +1 -1
  46. package/dist/cjs/api/resources/organization/client/getOrgIdsFromToken.js +1 -1
  47. package/dist/cjs/api/resources/organization/client/index.d.ts +1 -0
  48. package/dist/cjs/api/resources/organization/client/index.js +2 -1
  49. package/dist/cjs/api/resources/organization/client/inviteUser.js +1 -1
  50. package/dist/cjs/api/resources/organization/client/isMember.js +1 -1
  51. package/dist/cjs/api/resources/organization/client/removeUser.js +1 -1
  52. package/dist/cjs/api/resources/organization/client/requests/CreateOrganizationRequest.d.ts +8 -0
  53. package/dist/cjs/api/resources/organization/client/update.js +1 -1
  54. package/dist/cjs/api/resources/organization/types/Organization.d.ts +2 -0
  55. package/dist/cjs/api/resources/registry/client/Client.d.ts +12 -13
  56. package/dist/cjs/api/resources/registry/client/Client.js +28 -26
  57. package/dist/cjs/api/resources/registry/client/generateRegistryTokens.d.ts +6 -1
  58. package/dist/cjs/api/resources/registry/client/generateRegistryTokens.js +11 -1
  59. package/dist/cjs/api/resources/registry/client/hasRegistryPermission.js +1 -1
  60. package/dist/cjs/api/resources/registry/client/revokeToken.d.ts +6 -1
  61. package/dist/cjs/api/resources/registry/client/revokeToken.js +11 -1
  62. package/dist/cjs/api/resources/user/client/Client.d.ts +12 -13
  63. package/dist/cjs/api/resources/user/client/Client.js +27 -25
  64. package/dist/cjs/api/resources/user/client/getMyOrganizations.js +1 -1
  65. package/dist/cjs/api/resources/user/client/getMyself.js +1 -1
  66. package/dist/cjs/api/resources/user/client/linkAccounts.js +1 -1
  67. package/dist/cjs/auth/BearerAuthProvider.d.ts +20 -0
  68. package/dist/cjs/auth/BearerAuthProvider.js +76 -0
  69. package/dist/cjs/auth/index.d.ts +1 -0
  70. package/dist/cjs/auth/index.js +5 -0
  71. package/dist/cjs/core/auth/AuthProvider.d.ts +4 -1
  72. package/dist/cjs/core/auth/BearerToken.d.ts +3 -1
  73. package/dist/cjs/core/auth/BearerToken.js +7 -6
  74. package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
  75. package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
  76. package/dist/cjs/core/auth/index.d.ts +1 -0
  77. package/dist/cjs/core/auth/index.js +3 -1
  78. package/dist/cjs/core/exports.d.ts +1 -0
  79. package/dist/cjs/core/exports.js +17 -0
  80. package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
  81. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
  82. package/dist/cjs/core/fetcher/Fetcher.d.ts +10 -4
  83. package/dist/cjs/core/fetcher/Fetcher.js +210 -10
  84. package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
  85. package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
  86. package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
  87. package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
  88. package/dist/cjs/core/fetcher/makeRequest.js +0 -2
  89. package/dist/cjs/core/fetcher/requestWithRetries.js +0 -9
  90. package/dist/cjs/core/fetcher/signals.d.ts +1 -7
  91. package/dist/cjs/core/fetcher/signals.js +0 -12
  92. package/dist/cjs/core/headers.d.ts +2 -2
  93. package/dist/cjs/core/headers.js +6 -4
  94. package/dist/cjs/core/index.d.ts +1 -0
  95. package/dist/cjs/core/index.js +2 -1
  96. package/dist/cjs/core/logging/exports.d.ts +18 -0
  97. package/dist/cjs/core/logging/exports.js +45 -0
  98. package/dist/cjs/core/logging/index.d.ts +1 -0
  99. package/dist/cjs/core/logging/index.js +17 -0
  100. package/dist/cjs/core/logging/logger.d.ts +126 -0
  101. package/dist/cjs/core/logging/logger.js +144 -0
  102. package/dist/cjs/core/runtime/runtime.js +11 -10
  103. package/dist/cjs/core/schemas/Schema.d.ts +1 -0
  104. package/dist/cjs/core/schemas/Schema.js +1 -0
  105. package/dist/cjs/core/schemas/builders/object/object.js +34 -3
  106. package/dist/cjs/core/schemas/builders/primitives/index.d.ts +1 -0
  107. package/dist/cjs/core/schemas/builders/primitives/index.js +3 -1
  108. package/dist/cjs/core/schemas/builders/primitives/never.d.ts +2 -0
  109. package/dist/cjs/core/schemas/builders/primitives/never.js +14 -0
  110. package/dist/cjs/core/url/join.js +0 -1
  111. package/dist/cjs/exports.d.ts +1 -0
  112. package/dist/cjs/exports.js +17 -0
  113. package/dist/cjs/index.d.ts +1 -0
  114. package/dist/cjs/index.js +4 -0
  115. package/dist/cjs/serialization/resources/auth/client/getAutopilotToken.d.ts +10 -0
  116. package/dist/cjs/serialization/resources/auth/client/getAutopilotToken.js +66 -0
  117. package/dist/cjs/serialization/resources/auth/client/getJwt.d.ts +10 -0
  118. package/dist/cjs/serialization/resources/auth/client/getJwt.js +66 -0
  119. package/dist/cjs/serialization/resources/auth/client/getOrgForGithubOwner.d.ts +8 -0
  120. package/dist/cjs/serialization/resources/auth/client/getOrgForGithubOwner.js +6 -0
  121. package/dist/cjs/serialization/resources/auth/client/index.d.ts +4 -0
  122. package/dist/cjs/serialization/resources/auth/client/index.js +43 -0
  123. package/dist/cjs/serialization/resources/auth/client/requests/GetAutopilotTokenRequest.d.ts +11 -0
  124. package/dist/cjs/serialization/resources/auth/client/requests/GetAutopilotTokenRequest.js +43 -0
  125. package/dist/cjs/serialization/resources/auth/client/requests/GetJwtRequest.d.ts +10 -0
  126. package/dist/cjs/serialization/resources/auth/client/requests/GetJwtRequest.js +42 -0
  127. package/dist/cjs/serialization/resources/auth/client/requests/index.d.ts +2 -0
  128. package/dist/cjs/serialization/resources/auth/client/requests/index.js +7 -0
  129. package/dist/cjs/serialization/resources/auth/index.d.ts +2 -0
  130. package/dist/cjs/serialization/resources/auth/index.js +18 -0
  131. package/dist/cjs/serialization/resources/auth/types/JwtResponse.d.ts +10 -0
  132. package/dist/cjs/serialization/resources/auth/types/JwtResponse.js +42 -0
  133. package/dist/cjs/serialization/resources/auth/types/index.d.ts +1 -0
  134. package/dist/cjs/serialization/resources/auth/types/index.js +17 -0
  135. package/dist/cjs/serialization/resources/index.d.ts +3 -0
  136. package/dist/cjs/serialization/resources/index.js +4 -1
  137. package/dist/cjs/serialization/resources/organization/client/getByPostmanTeamId.d.ts +10 -0
  138. package/dist/cjs/serialization/resources/organization/client/getByPostmanTeamId.js +66 -0
  139. package/dist/cjs/serialization/resources/organization/client/index.d.ts +1 -0
  140. package/dist/cjs/serialization/resources/organization/client/index.js +2 -1
  141. package/dist/cjs/serialization/resources/organization/client/requests/CreateOrganizationRequest.d.ts +2 -0
  142. package/dist/cjs/serialization/resources/organization/client/requests/CreateOrganizationRequest.js +2 -0
  143. package/dist/cjs/serialization/resources/organization/types/Organization.d.ts +1 -0
  144. package/dist/cjs/serialization/resources/organization/types/Organization.js +1 -0
  145. package/dist/cjs/serialization/resources/registry/client/generateRegistryTokens.d.ts +4 -1
  146. package/dist/cjs/serialization/resources/registry/client/generateRegistryTokens.js +3 -0
  147. package/dist/cjs/serialization/resources/registry/client/revokeToken.d.ts +4 -1
  148. package/dist/cjs/serialization/resources/registry/client/revokeToken.js +3 -0
  149. package/dist/cjs/version.d.ts +1 -1
  150. package/dist/cjs/version.js +1 -1
  151. package/dist/esm/BaseClient.d.mts +17 -4
  152. package/dist/esm/BaseClient.mjs +24 -1
  153. package/dist/esm/Client.d.mts +19 -16
  154. package/dist/esm/Client.mjs +16 -18
  155. package/dist/esm/api/resources/apiKeys/client/Client.d.mts +16 -17
  156. package/dist/esm/api/resources/apiKeys/client/Client.mjs +40 -33
  157. package/dist/esm/api/resources/apiKeys/client/create.mjs +1 -1
  158. package/dist/esm/api/resources/apiKeys/client/getTokenMetadata.mjs +1 -1
  159. package/dist/esm/api/resources/apiKeys/client/getTokensForOrganization.mjs +1 -1
  160. package/dist/esm/api/resources/apiKeys/client/revokeToken.mjs +1 -1
  161. package/dist/esm/api/resources/apiKeys/client/revokeTokenById.mjs +1 -1
  162. package/dist/esm/api/resources/auth/client/Client.d.mts +69 -0
  163. package/dist/esm/api/resources/auth/client/Client.mjs +258 -0
  164. package/dist/esm/api/resources/auth/client/getAutopilotToken.d.mts +24 -0
  165. package/dist/esm/api/resources/auth/client/getAutopilotToken.mjs +29 -0
  166. package/dist/esm/api/resources/auth/client/getJwt.d.mts +24 -0
  167. package/dist/esm/api/resources/auth/client/getJwt.mjs +29 -0
  168. package/dist/esm/api/resources/auth/client/getOrgForGithubOwner.d.mts +19 -0
  169. package/dist/esm/api/resources/auth/client/getOrgForGithubOwner.mjs +19 -0
  170. package/dist/esm/api/resources/auth/client/index.d.mts +4 -0
  171. package/dist/esm/api/resources/auth/client/index.mjs +4 -0
  172. package/dist/esm/api/resources/auth/client/requests/GetAutopilotTokenRequest.d.mts +22 -0
  173. package/dist/esm/api/resources/auth/client/requests/GetAutopilotTokenRequest.mjs +2 -0
  174. package/dist/esm/api/resources/auth/client/requests/GetJwtRequest.d.mts +16 -0
  175. package/dist/esm/api/resources/auth/client/requests/GetJwtRequest.mjs +2 -0
  176. package/dist/esm/api/resources/auth/client/requests/index.d.mts +2 -0
  177. package/dist/esm/api/resources/auth/client/requests/index.mjs +1 -0
  178. package/dist/esm/api/resources/auth/index.d.mts +2 -0
  179. package/dist/esm/api/resources/auth/index.mjs +2 -0
  180. package/dist/esm/api/resources/auth/types/JwtResponse.d.mts +11 -0
  181. package/dist/esm/api/resources/auth/types/JwtResponse.mjs +2 -0
  182. package/dist/esm/api/resources/auth/types/index.d.mts +1 -0
  183. package/dist/esm/api/resources/auth/types/index.mjs +1 -0
  184. package/dist/esm/api/resources/index.d.mts +3 -0
  185. package/dist/esm/api/resources/index.mjs +3 -0
  186. package/dist/esm/api/resources/organization/client/Client.d.mts +37 -27
  187. package/dist/esm/api/resources/organization/client/Client.mjs +151 -59
  188. package/dist/esm/api/resources/organization/client/addUser.mjs +1 -1
  189. package/dist/esm/api/resources/organization/client/create.mjs +1 -1
  190. package/dist/esm/api/resources/organization/client/delete.mjs +1 -1
  191. package/dist/esm/api/resources/organization/client/get.mjs +1 -1
  192. package/dist/esm/api/resources/organization/client/getByPostmanTeamId.d.mts +24 -0
  193. package/dist/esm/api/resources/organization/client/getByPostmanTeamId.mjs +29 -0
  194. package/dist/esm/api/resources/organization/client/getMyOrganizationFromScopedToken.mjs +1 -1
  195. package/dist/esm/api/resources/organization/client/getOrgIdsFromToken.mjs +1 -1
  196. package/dist/esm/api/resources/organization/client/index.d.mts +1 -0
  197. package/dist/esm/api/resources/organization/client/index.mjs +1 -0
  198. package/dist/esm/api/resources/organization/client/inviteUser.mjs +1 -1
  199. package/dist/esm/api/resources/organization/client/isMember.mjs +1 -1
  200. package/dist/esm/api/resources/organization/client/removeUser.mjs +1 -1
  201. package/dist/esm/api/resources/organization/client/requests/CreateOrganizationRequest.d.mts +8 -0
  202. package/dist/esm/api/resources/organization/client/update.mjs +1 -1
  203. package/dist/esm/api/resources/organization/types/Organization.d.mts +2 -0
  204. package/dist/esm/api/resources/registry/client/Client.d.mts +12 -13
  205. package/dist/esm/api/resources/registry/client/Client.mjs +27 -25
  206. package/dist/esm/api/resources/registry/client/generateRegistryTokens.d.mts +6 -1
  207. package/dist/esm/api/resources/registry/client/generateRegistryTokens.mjs +11 -1
  208. package/dist/esm/api/resources/registry/client/hasRegistryPermission.mjs +1 -1
  209. package/dist/esm/api/resources/registry/client/revokeToken.d.mts +6 -1
  210. package/dist/esm/api/resources/registry/client/revokeToken.mjs +11 -1
  211. package/dist/esm/api/resources/user/client/Client.d.mts +12 -13
  212. package/dist/esm/api/resources/user/client/Client.mjs +26 -24
  213. package/dist/esm/api/resources/user/client/getMyOrganizations.mjs +1 -1
  214. package/dist/esm/api/resources/user/client/getMyself.mjs +1 -1
  215. package/dist/esm/api/resources/user/client/linkAccounts.mjs +1 -1
  216. package/dist/esm/auth/BearerAuthProvider.d.mts +20 -0
  217. package/dist/esm/auth/BearerAuthProvider.mjs +39 -0
  218. package/dist/esm/auth/index.d.mts +1 -0
  219. package/dist/esm/auth/index.mjs +1 -0
  220. package/dist/esm/core/auth/AuthProvider.d.mts +4 -1
  221. package/dist/esm/core/auth/BearerToken.d.mts +3 -1
  222. package/dist/esm/core/auth/BearerToken.mjs +7 -6
  223. package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
  224. package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
  225. package/dist/esm/core/auth/index.d.mts +1 -0
  226. package/dist/esm/core/auth/index.mjs +1 -0
  227. package/dist/esm/core/exports.d.mts +1 -0
  228. package/dist/esm/core/exports.mjs +1 -0
  229. package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
  230. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
  231. package/dist/esm/core/fetcher/Fetcher.d.mts +10 -4
  232. package/dist/esm/core/fetcher/Fetcher.mjs +210 -10
  233. package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
  234. package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
  235. package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
  236. package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
  237. package/dist/esm/core/fetcher/makeRequest.mjs +0 -2
  238. package/dist/esm/core/fetcher/requestWithRetries.mjs +0 -9
  239. package/dist/esm/core/fetcher/signals.d.mts +1 -7
  240. package/dist/esm/core/fetcher/signals.mjs +0 -12
  241. package/dist/esm/core/headers.d.mts +2 -2
  242. package/dist/esm/core/headers.mjs +6 -4
  243. package/dist/esm/core/index.d.mts +1 -0
  244. package/dist/esm/core/index.mjs +1 -0
  245. package/dist/esm/core/logging/exports.d.mts +18 -0
  246. package/dist/esm/core/logging/exports.mjs +9 -0
  247. package/dist/esm/core/logging/index.d.mts +1 -0
  248. package/dist/esm/core/logging/index.mjs +1 -0
  249. package/dist/esm/core/logging/logger.d.mts +126 -0
  250. package/dist/esm/core/logging/logger.mjs +138 -0
  251. package/dist/esm/core/runtime/runtime.mjs +11 -10
  252. package/dist/esm/core/schemas/Schema.d.mts +1 -0
  253. package/dist/esm/core/schemas/Schema.mjs +1 -0
  254. package/dist/esm/core/schemas/builders/object/object.mjs +34 -3
  255. package/dist/esm/core/schemas/builders/primitives/index.d.mts +1 -0
  256. package/dist/esm/core/schemas/builders/primitives/index.mjs +1 -0
  257. package/dist/esm/core/schemas/builders/primitives/never.d.mts +2 -0
  258. package/dist/esm/core/schemas/builders/primitives/never.mjs +11 -0
  259. package/dist/esm/core/url/join.mjs +0 -1
  260. package/dist/esm/exports.d.mts +1 -0
  261. package/dist/esm/exports.mjs +1 -0
  262. package/dist/esm/index.d.mts +1 -0
  263. package/dist/esm/index.mjs +1 -0
  264. package/dist/esm/serialization/resources/auth/client/getAutopilotToken.d.mts +10 -0
  265. package/dist/esm/serialization/resources/auth/client/getAutopilotToken.mjs +30 -0
  266. package/dist/esm/serialization/resources/auth/client/getJwt.d.mts +10 -0
  267. package/dist/esm/serialization/resources/auth/client/getJwt.mjs +30 -0
  268. package/dist/esm/serialization/resources/auth/client/getOrgForGithubOwner.d.mts +8 -0
  269. package/dist/esm/serialization/resources/auth/client/getOrgForGithubOwner.mjs +3 -0
  270. package/dist/esm/serialization/resources/auth/client/index.d.mts +4 -0
  271. package/dist/esm/serialization/resources/auth/client/index.mjs +4 -0
  272. package/dist/esm/serialization/resources/auth/client/requests/GetAutopilotTokenRequest.d.mts +11 -0
  273. package/dist/esm/serialization/resources/auth/client/requests/GetAutopilotTokenRequest.mjs +7 -0
  274. package/dist/esm/serialization/resources/auth/client/requests/GetJwtRequest.d.mts +10 -0
  275. package/dist/esm/serialization/resources/auth/client/requests/GetJwtRequest.mjs +6 -0
  276. package/dist/esm/serialization/resources/auth/client/requests/index.d.mts +2 -0
  277. package/dist/esm/serialization/resources/auth/client/requests/index.mjs +2 -0
  278. package/dist/esm/serialization/resources/auth/index.d.mts +2 -0
  279. package/dist/esm/serialization/resources/auth/index.mjs +2 -0
  280. package/dist/esm/serialization/resources/auth/types/JwtResponse.d.mts +10 -0
  281. package/dist/esm/serialization/resources/auth/types/JwtResponse.mjs +6 -0
  282. package/dist/esm/serialization/resources/auth/types/index.d.mts +1 -0
  283. package/dist/esm/serialization/resources/auth/types/index.mjs +1 -0
  284. package/dist/esm/serialization/resources/index.d.mts +3 -0
  285. package/dist/esm/serialization/resources/index.mjs +3 -0
  286. package/dist/esm/serialization/resources/organization/client/getByPostmanTeamId.d.mts +10 -0
  287. package/dist/esm/serialization/resources/organization/client/getByPostmanTeamId.mjs +30 -0
  288. package/dist/esm/serialization/resources/organization/client/index.d.mts +1 -0
  289. package/dist/esm/serialization/resources/organization/client/index.mjs +1 -0
  290. package/dist/esm/serialization/resources/organization/client/requests/CreateOrganizationRequest.d.mts +2 -0
  291. package/dist/esm/serialization/resources/organization/client/requests/CreateOrganizationRequest.mjs +2 -0
  292. package/dist/esm/serialization/resources/organization/types/Organization.d.mts +1 -0
  293. package/dist/esm/serialization/resources/organization/types/Organization.mjs +1 -0
  294. package/dist/esm/serialization/resources/registry/client/generateRegistryTokens.d.mts +4 -1
  295. package/dist/esm/serialization/resources/registry/client/generateRegistryTokens.mjs +3 -0
  296. package/dist/esm/serialization/resources/registry/client/revokeToken.d.mts +4 -1
  297. package/dist/esm/serialization/resources/registry/client/revokeToken.mjs +3 -0
  298. package/dist/esm/version.d.mts +1 -1
  299. package/dist/esm/version.mjs +1 -1
  300. package/package.json +8 -3
  301. package/reference.md +1369 -0
  302. package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
  303. package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
  304. package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
  305. package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
package/reference.md ADDED
@@ -0,0 +1,1369 @@
1
+ # Reference
2
+ ## ApiKeys
3
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">create</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.CreateTokenResponse, FernVenusApi.apiKeys.create.Error&gt;</code></summary>
4
+ <dl>
5
+ <dd>
6
+
7
+ #### 🔌 Usage
8
+
9
+ <dl>
10
+ <dd>
11
+
12
+ <dl>
13
+ <dd>
14
+
15
+ ```typescript
16
+ await client.apiKeys.create({
17
+ organizationId: "some-org-id"
18
+ });
19
+
20
+ ```
21
+ </dd>
22
+ </dl>
23
+ </dd>
24
+ </dl>
25
+
26
+ #### ⚙️ Parameters
27
+
28
+ <dl>
29
+ <dd>
30
+
31
+ <dl>
32
+ <dd>
33
+
34
+ **request:** `FernVenusApi.CreateApiKeyRequest`
35
+
36
+ </dd>
37
+ </dl>
38
+
39
+ <dl>
40
+ <dd>
41
+
42
+ **requestOptions:** `ApiKeysClient.RequestOptions`
43
+
44
+ </dd>
45
+ </dl>
46
+ </dd>
47
+ </dl>
48
+
49
+
50
+ </dd>
51
+ </dl>
52
+ </details>
53
+
54
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">getTokenMetadata</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.TokenMetadata, FernVenusApi.apiKeys.getTokenMetadata.Error&gt;</code></summary>
55
+ <dl>
56
+ <dd>
57
+
58
+ #### 🔌 Usage
59
+
60
+ <dl>
61
+ <dd>
62
+
63
+ <dl>
64
+ <dd>
65
+
66
+ ```typescript
67
+ await client.apiKeys.getTokenMetadata({
68
+ token: "token-value"
69
+ });
70
+
71
+ ```
72
+ </dd>
73
+ </dl>
74
+ </dd>
75
+ </dl>
76
+
77
+ #### ⚙️ Parameters
78
+
79
+ <dl>
80
+ <dd>
81
+
82
+ <dl>
83
+ <dd>
84
+
85
+ **request:** `FernVenusApi.GetTokenMetadataRequest`
86
+
87
+ </dd>
88
+ </dl>
89
+
90
+ <dl>
91
+ <dd>
92
+
93
+ **requestOptions:** `ApiKeysClient.RequestOptions`
94
+
95
+ </dd>
96
+ </dl>
97
+ </dd>
98
+ </dl>
99
+
100
+
101
+ </dd>
102
+ </dl>
103
+ </details>
104
+
105
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">getTokensForOrganization</a>(organizationId) -> core.APIResponse&lt;FernVenusApi.TokenMetadata[], FernVenusApi.apiKeys.getTokensForOrganization.Error&gt;</code></summary>
106
+ <dl>
107
+ <dd>
108
+
109
+ #### 🔌 Usage
110
+
111
+ <dl>
112
+ <dd>
113
+
114
+ <dl>
115
+ <dd>
116
+
117
+ ```typescript
118
+ await client.apiKeys.getTokensForOrganization("some-org-id");
119
+
120
+ ```
121
+ </dd>
122
+ </dl>
123
+ </dd>
124
+ </dl>
125
+
126
+ #### ⚙️ Parameters
127
+
128
+ <dl>
129
+ <dd>
130
+
131
+ <dl>
132
+ <dd>
133
+
134
+ **organizationId:** `FernVenusApi.OrganizationId`
135
+
136
+ </dd>
137
+ </dl>
138
+
139
+ <dl>
140
+ <dd>
141
+
142
+ **requestOptions:** `ApiKeysClient.RequestOptions`
143
+
144
+ </dd>
145
+ </dl>
146
+ </dd>
147
+ </dl>
148
+
149
+
150
+ </dd>
151
+ </dl>
152
+ </details>
153
+
154
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">revokeTokenById</a>(tokenId) -> core.APIResponse&lt;void, FernVenusApi.apiKeys.revokeTokenById.Error&gt;</code></summary>
155
+ <dl>
156
+ <dd>
157
+
158
+ #### 🔌 Usage
159
+
160
+ <dl>
161
+ <dd>
162
+
163
+ <dl>
164
+ <dd>
165
+
166
+ ```typescript
167
+ await client.apiKeys.revokeTokenById("some-token-id");
168
+
169
+ ```
170
+ </dd>
171
+ </dl>
172
+ </dd>
173
+ </dl>
174
+
175
+ #### ⚙️ Parameters
176
+
177
+ <dl>
178
+ <dd>
179
+
180
+ <dl>
181
+ <dd>
182
+
183
+ **tokenId:** `FernVenusApi.TokenId`
184
+
185
+ </dd>
186
+ </dl>
187
+
188
+ <dl>
189
+ <dd>
190
+
191
+ **requestOptions:** `ApiKeysClient.RequestOptions`
192
+
193
+ </dd>
194
+ </dl>
195
+ </dd>
196
+ </dl>
197
+
198
+
199
+ </dd>
200
+ </dl>
201
+ </details>
202
+
203
+ <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">revokeToken</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.apiKeys.revokeToken.Error&gt;</code></summary>
204
+ <dl>
205
+ <dd>
206
+
207
+ #### 🔌 Usage
208
+
209
+ <dl>
210
+ <dd>
211
+
212
+ <dl>
213
+ <dd>
214
+
215
+ ```typescript
216
+ await client.apiKeys.revokeToken({
217
+ token: "some-token-value"
218
+ });
219
+
220
+ ```
221
+ </dd>
222
+ </dl>
223
+ </dd>
224
+ </dl>
225
+
226
+ #### ⚙️ Parameters
227
+
228
+ <dl>
229
+ <dd>
230
+
231
+ <dl>
232
+ <dd>
233
+
234
+ **request:** `FernVenusApi.RevokeApiKeyRequest`
235
+
236
+ </dd>
237
+ </dl>
238
+
239
+ <dl>
240
+ <dd>
241
+
242
+ **requestOptions:** `ApiKeysClient.RequestOptions`
243
+
244
+ </dd>
245
+ </dl>
246
+ </dd>
247
+ </dl>
248
+
249
+
250
+ </dd>
251
+ </dl>
252
+ </details>
253
+
254
+ ## Auth
255
+ <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getOrgForGithubOwner</a>(githubOwner) -> core.APIResponse&lt;FernVenusApi.OrganizationId | undefined, FernVenusApi.auth.getOrgForGithubOwner.Error&gt;</code></summary>
256
+ <dl>
257
+ <dd>
258
+
259
+ #### 📝 Description
260
+
261
+ <dl>
262
+ <dd>
263
+
264
+ <dl>
265
+ <dd>
266
+
267
+ Look up the Fern organization ID for a GitHub owner.
268
+ This endpoint is unauthenticated and used by Fiddle to look up the
269
+ centralized protected GitHub orgs mapping.
270
+ </dd>
271
+ </dl>
272
+ </dd>
273
+ </dl>
274
+
275
+ #### 🔌 Usage
276
+
277
+ <dl>
278
+ <dd>
279
+
280
+ <dl>
281
+ <dd>
282
+
283
+ ```typescript
284
+ await client.auth.getOrgForGithubOwner("protected-github-owner");
285
+
286
+ ```
287
+ </dd>
288
+ </dl>
289
+ </dd>
290
+ </dl>
291
+
292
+ #### ⚙️ Parameters
293
+
294
+ <dl>
295
+ <dd>
296
+
297
+ <dl>
298
+ <dd>
299
+
300
+ **githubOwner:** `string` — The GitHub repo owner (case-insensitive)
301
+
302
+ </dd>
303
+ </dl>
304
+
305
+ <dl>
306
+ <dd>
307
+
308
+ **requestOptions:** `AuthClient.RequestOptions`
309
+
310
+ </dd>
311
+ </dl>
312
+ </dd>
313
+ </dl>
314
+
315
+
316
+ </dd>
317
+ </dl>
318
+ </details>
319
+
320
+ <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getAutopilotToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.JwtResponse, FernVenusApi.auth.getAutopilotToken.Error&gt;</code></summary>
321
+ <dl>
322
+ <dd>
323
+
324
+ #### 📝 Description
325
+
326
+ <dl>
327
+ <dd>
328
+
329
+ <dl>
330
+ <dd>
331
+
332
+ Exchange an autopilot token for a short-lived JWT scoped to an organization.
333
+ This endpoint is used by automated systems (like Fiddle) to get org-scoped tokens.
334
+ If a GitHub owner is provided and is in the protected GitHub orgs mapping,
335
+ the organization ID must match the allowed org for that GitHub owner.
336
+ The returned token is identical to tokens from getJwt and can be used the same way.
337
+ </dd>
338
+ </dl>
339
+ </dd>
340
+ </dl>
341
+
342
+ #### 🔌 Usage
343
+
344
+ <dl>
345
+ <dd>
346
+
347
+ <dl>
348
+ <dd>
349
+
350
+ ```typescript
351
+ await client.auth.getAutopilotToken({
352
+ organizationId: "my-org-id"
353
+ });
354
+
355
+ ```
356
+ </dd>
357
+ </dl>
358
+ </dd>
359
+ </dl>
360
+
361
+ #### ⚙️ Parameters
362
+
363
+ <dl>
364
+ <dd>
365
+
366
+ <dl>
367
+ <dd>
368
+
369
+ **request:** `FernVenusApi.GetAutopilotTokenRequest`
370
+
371
+ </dd>
372
+ </dl>
373
+
374
+ <dl>
375
+ <dd>
376
+
377
+ **requestOptions:** `AuthClient.RequestOptions`
378
+
379
+ </dd>
380
+ </dl>
381
+ </dd>
382
+ </dl>
383
+
384
+
385
+ </dd>
386
+ </dl>
387
+ </details>
388
+
389
+ <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getJwt</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.JwtResponse, FernVenusApi.auth.getJwt.Error&gt;</code></summary>
390
+ <dl>
391
+ <dd>
392
+
393
+ #### 📝 Description
394
+
395
+ <dl>
396
+ <dd>
397
+
398
+ <dl>
399
+ <dd>
400
+
401
+ Exchange a user token for a short-lived JWT scoped to an organization.
402
+ The user must be a member of the specified organization.
403
+ The JWT can be used to authenticate requests to other services.
404
+ </dd>
405
+ </dl>
406
+ </dd>
407
+ </dl>
408
+
409
+ #### 🔌 Usage
410
+
411
+ <dl>
412
+ <dd>
413
+
414
+ <dl>
415
+ <dd>
416
+
417
+ ```typescript
418
+ await client.auth.getJwt({
419
+ organizationId: "my-org-id"
420
+ });
421
+
422
+ ```
423
+ </dd>
424
+ </dl>
425
+ </dd>
426
+ </dl>
427
+
428
+ #### ⚙️ Parameters
429
+
430
+ <dl>
431
+ <dd>
432
+
433
+ <dl>
434
+ <dd>
435
+
436
+ **request:** `FernVenusApi.GetJwtRequest`
437
+
438
+ </dd>
439
+ </dl>
440
+
441
+ <dl>
442
+ <dd>
443
+
444
+ **requestOptions:** `AuthClient.RequestOptions`
445
+
446
+ </dd>
447
+ </dl>
448
+ </dd>
449
+ </dl>
450
+
451
+
452
+ </dd>
453
+ </dl>
454
+ </details>
455
+
456
+ ## Organization
457
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">create</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error&gt;</code></summary>
458
+ <dl>
459
+ <dd>
460
+
461
+ #### 🔌 Usage
462
+
463
+ <dl>
464
+ <dd>
465
+
466
+ <dl>
467
+ <dd>
468
+
469
+ ```typescript
470
+ await client.organization.create({
471
+ organizationId: "organizationId"
472
+ });
473
+
474
+ ```
475
+ </dd>
476
+ </dl>
477
+ </dd>
478
+ </dl>
479
+
480
+ #### ⚙️ Parameters
481
+
482
+ <dl>
483
+ <dd>
484
+
485
+ <dl>
486
+ <dd>
487
+
488
+ **request:** `FernVenusApi.CreateOrganizationRequest`
489
+
490
+ </dd>
491
+ </dl>
492
+
493
+ <dl>
494
+ <dd>
495
+
496
+ **requestOptions:** `OrganizationClient.RequestOptions`
497
+
498
+ </dd>
499
+ </dl>
500
+ </dd>
501
+ </dl>
502
+
503
+
504
+ </dd>
505
+ </dl>
506
+ </details>
507
+
508
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">update</a>(orgId, { ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.update.Error&gt;</code></summary>
509
+ <dl>
510
+ <dd>
511
+
512
+ #### 🔌 Usage
513
+
514
+ <dl>
515
+ <dd>
516
+
517
+ <dl>
518
+ <dd>
519
+
520
+ ```typescript
521
+ await client.organization.update("orgId");
522
+
523
+ ```
524
+ </dd>
525
+ </dl>
526
+ </dd>
527
+ </dl>
528
+
529
+ #### ⚙️ Parameters
530
+
531
+ <dl>
532
+ <dd>
533
+
534
+ <dl>
535
+ <dd>
536
+
537
+ **orgId:** `FernVenusApi.OrganizationId`
538
+
539
+ </dd>
540
+ </dl>
541
+
542
+ <dl>
543
+ <dd>
544
+
545
+ **request:** `FernVenusApi.UpdateOrganizationRequest`
546
+
547
+ </dd>
548
+ </dl>
549
+
550
+ <dl>
551
+ <dd>
552
+
553
+ **requestOptions:** `OrganizationClient.RequestOptions`
554
+
555
+ </dd>
556
+ </dl>
557
+ </dd>
558
+ </dl>
559
+
560
+
561
+ </dd>
562
+ </dl>
563
+ </details>
564
+
565
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">get</a>(orgId, { ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.get.Error&gt;</code></summary>
566
+ <dl>
567
+ <dd>
568
+
569
+ #### 🔌 Usage
570
+
571
+ <dl>
572
+ <dd>
573
+
574
+ <dl>
575
+ <dd>
576
+
577
+ ```typescript
578
+ await client.organization.get("orgId");
579
+
580
+ ```
581
+ </dd>
582
+ </dl>
583
+ </dd>
584
+ </dl>
585
+
586
+ #### ⚙️ Parameters
587
+
588
+ <dl>
589
+ <dd>
590
+
591
+ <dl>
592
+ <dd>
593
+
594
+ **orgId:** `FernVenusApi.OrganizationId`
595
+
596
+ </dd>
597
+ </dl>
598
+
599
+ <dl>
600
+ <dd>
601
+
602
+ **request:** `FernVenusApi.GetOrganizationRequest`
603
+
604
+ </dd>
605
+ </dl>
606
+
607
+ <dl>
608
+ <dd>
609
+
610
+ **requestOptions:** `OrganizationClient.RequestOptions`
611
+
612
+ </dd>
613
+ </dl>
614
+ </dd>
615
+ </dl>
616
+
617
+
618
+ </dd>
619
+ </dl>
620
+ </details>
621
+
622
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getByPostmanTeamId</a>(postmanTeamId) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getByPostmanTeamId.Error&gt;</code></summary>
623
+ <dl>
624
+ <dd>
625
+
626
+ #### 📝 Description
627
+
628
+ <dl>
629
+ <dd>
630
+
631
+ <dl>
632
+ <dd>
633
+
634
+ Look up an organization by its associated Postman team ID.
635
+ </dd>
636
+ </dl>
637
+ </dd>
638
+ </dl>
639
+
640
+ #### 🔌 Usage
641
+
642
+ <dl>
643
+ <dd>
644
+
645
+ <dl>
646
+ <dd>
647
+
648
+ ```typescript
649
+ await client.organization.getByPostmanTeamId("postmanTeamId");
650
+
651
+ ```
652
+ </dd>
653
+ </dl>
654
+ </dd>
655
+ </dl>
656
+
657
+ #### ⚙️ Parameters
658
+
659
+ <dl>
660
+ <dd>
661
+
662
+ <dl>
663
+ <dd>
664
+
665
+ **postmanTeamId:** `string` — The Postman team ID to look up
666
+
667
+ </dd>
668
+ </dl>
669
+
670
+ <dl>
671
+ <dd>
672
+
673
+ **requestOptions:** `OrganizationClient.RequestOptions`
674
+
675
+ </dd>
676
+ </dl>
677
+ </dd>
678
+ </dl>
679
+
680
+
681
+ </dd>
682
+ </dl>
683
+ </details>
684
+
685
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">isMember</a>(organizationId) -> core.APIResponse&lt;boolean, FernVenusApi.organization.isMember.Error&gt;</code></summary>
686
+ <dl>
687
+ <dd>
688
+
689
+ #### 🔌 Usage
690
+
691
+ <dl>
692
+ <dd>
693
+
694
+ <dl>
695
+ <dd>
696
+
697
+ ```typescript
698
+ await client.organization.isMember("organizationId");
699
+
700
+ ```
701
+ </dd>
702
+ </dl>
703
+ </dd>
704
+ </dl>
705
+
706
+ #### ⚙️ Parameters
707
+
708
+ <dl>
709
+ <dd>
710
+
711
+ <dl>
712
+ <dd>
713
+
714
+ **organizationId:** `FernVenusApi.OrganizationId`
715
+
716
+ </dd>
717
+ </dl>
718
+
719
+ <dl>
720
+ <dd>
721
+
722
+ **requestOptions:** `OrganizationClient.RequestOptions`
723
+
724
+ </dd>
725
+ </dl>
726
+ </dd>
727
+ </dl>
728
+
729
+
730
+ </dd>
731
+ </dl>
732
+ </details>
733
+
734
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getMyOrganizationFromScopedToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error&gt;</code></summary>
735
+ <dl>
736
+ <dd>
737
+
738
+ #### 📝 Description
739
+
740
+ <dl>
741
+ <dd>
742
+
743
+ <dl>
744
+ <dd>
745
+
746
+ Returns the org for a scoped token. The token is limited to one organization.
747
+ </dd>
748
+ </dl>
749
+ </dd>
750
+ </dl>
751
+
752
+ #### 🔌 Usage
753
+
754
+ <dl>
755
+ <dd>
756
+
757
+ <dl>
758
+ <dd>
759
+
760
+ ```typescript
761
+ await client.organization.getMyOrganizationFromScopedToken();
762
+
763
+ ```
764
+ </dd>
765
+ </dl>
766
+ </dd>
767
+ </dl>
768
+
769
+ #### ⚙️ Parameters
770
+
771
+ <dl>
772
+ <dd>
773
+
774
+ <dl>
775
+ <dd>
776
+
777
+ **request:** `FernVenusApi.GetMyOrganizationFromScopedToken`
778
+
779
+ </dd>
780
+ </dl>
781
+
782
+ <dl>
783
+ <dd>
784
+
785
+ **requestOptions:** `OrganizationClient.RequestOptions`
786
+
787
+ </dd>
788
+ </dl>
789
+ </dd>
790
+ </dl>
791
+
792
+
793
+ </dd>
794
+ </dl>
795
+ </details>
796
+
797
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsFromToken</a>() -> core.APIResponse&lt;FernVenusApi.OrganizationId[], FernVenusApi.organization.getOrgIdsFromToken.Error&gt;</code></summary>
798
+ <dl>
799
+ <dd>
800
+
801
+ #### 🔌 Usage
802
+
803
+ <dl>
804
+ <dd>
805
+
806
+ <dl>
807
+ <dd>
808
+
809
+ ```typescript
810
+ await client.organization.getOrgIdsFromToken();
811
+
812
+ ```
813
+ </dd>
814
+ </dl>
815
+ </dd>
816
+ </dl>
817
+
818
+ #### ⚙️ Parameters
819
+
820
+ <dl>
821
+ <dd>
822
+
823
+ <dl>
824
+ <dd>
825
+
826
+ **requestOptions:** `OrganizationClient.RequestOptions`
827
+
828
+ </dd>
829
+ </dl>
830
+ </dd>
831
+ </dl>
832
+
833
+
834
+ </dd>
835
+ </dl>
836
+ </details>
837
+
838
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">addUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.addUser.Error&gt;</code></summary>
839
+ <dl>
840
+ <dd>
841
+
842
+ #### 🔌 Usage
843
+
844
+ <dl>
845
+ <dd>
846
+
847
+ <dl>
848
+ <dd>
849
+
850
+ ```typescript
851
+ await client.organization.addUser({
852
+ userId: "userId",
853
+ orgId: "orgId"
854
+ });
855
+
856
+ ```
857
+ </dd>
858
+ </dl>
859
+ </dd>
860
+ </dl>
861
+
862
+ #### ⚙️ Parameters
863
+
864
+ <dl>
865
+ <dd>
866
+
867
+ <dl>
868
+ <dd>
869
+
870
+ **request:** `FernVenusApi.AddUserToOrgRequest`
871
+
872
+ </dd>
873
+ </dl>
874
+
875
+ <dl>
876
+ <dd>
877
+
878
+ **requestOptions:** `OrganizationClient.RequestOptions`
879
+
880
+ </dd>
881
+ </dl>
882
+ </dd>
883
+ </dl>
884
+
885
+
886
+ </dd>
887
+ </dl>
888
+ </details>
889
+
890
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">inviteUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.inviteUser.Error&gt;</code></summary>
891
+ <dl>
892
+ <dd>
893
+
894
+ #### 🔌 Usage
895
+
896
+ <dl>
897
+ <dd>
898
+
899
+ <dl>
900
+ <dd>
901
+
902
+ ```typescript
903
+ await client.organization.inviteUser({
904
+ emailAddress: "emailAddress",
905
+ auth0OrgId: "auth0OrgId"
906
+ });
907
+
908
+ ```
909
+ </dd>
910
+ </dl>
911
+ </dd>
912
+ </dl>
913
+
914
+ #### ⚙️ Parameters
915
+
916
+ <dl>
917
+ <dd>
918
+
919
+ <dl>
920
+ <dd>
921
+
922
+ **request:** `FernVenusApi.InviteUserToOrgRequest`
923
+
924
+ </dd>
925
+ </dl>
926
+
927
+ <dl>
928
+ <dd>
929
+
930
+ **requestOptions:** `OrganizationClient.RequestOptions`
931
+
932
+ </dd>
933
+ </dl>
934
+ </dd>
935
+ </dl>
936
+
937
+
938
+ </dd>
939
+ </dl>
940
+ </details>
941
+
942
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">removeUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.removeUser.Error&gt;</code></summary>
943
+ <dl>
944
+ <dd>
945
+
946
+ #### 🔌 Usage
947
+
948
+ <dl>
949
+ <dd>
950
+
951
+ <dl>
952
+ <dd>
953
+
954
+ ```typescript
955
+ await client.organization.removeUser({
956
+ userId: "userId",
957
+ auth0OrgId: "auth0OrgId"
958
+ });
959
+
960
+ ```
961
+ </dd>
962
+ </dl>
963
+ </dd>
964
+ </dl>
965
+
966
+ #### ⚙️ Parameters
967
+
968
+ <dl>
969
+ <dd>
970
+
971
+ <dl>
972
+ <dd>
973
+
974
+ **request:** `FernVenusApi.RemoveUserFromOrgRequest`
975
+
976
+ </dd>
977
+ </dl>
978
+
979
+ <dl>
980
+ <dd>
981
+
982
+ **requestOptions:** `OrganizationClient.RequestOptions`
983
+
984
+ </dd>
985
+ </dl>
986
+ </dd>
987
+ </dl>
988
+
989
+
990
+ </dd>
991
+ </dl>
992
+ </details>
993
+
994
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">delete</a>(orgId) -> core.APIResponse&lt;void, FernVenusApi.organization.delete.Error&gt;</code></summary>
995
+ <dl>
996
+ <dd>
997
+
998
+ #### 📝 Description
999
+
1000
+ <dl>
1001
+ <dd>
1002
+
1003
+ <dl>
1004
+ <dd>
1005
+
1006
+ Deletes an organization. Only users with admin role can delete organizations.
1007
+ </dd>
1008
+ </dl>
1009
+ </dd>
1010
+ </dl>
1011
+
1012
+ #### 🔌 Usage
1013
+
1014
+ <dl>
1015
+ <dd>
1016
+
1017
+ <dl>
1018
+ <dd>
1019
+
1020
+ ```typescript
1021
+ await client.organization.delete("orgId");
1022
+
1023
+ ```
1024
+ </dd>
1025
+ </dl>
1026
+ </dd>
1027
+ </dl>
1028
+
1029
+ #### ⚙️ Parameters
1030
+
1031
+ <dl>
1032
+ <dd>
1033
+
1034
+ <dl>
1035
+ <dd>
1036
+
1037
+ **orgId:** `FernVenusApi.OrganizationId`
1038
+
1039
+ </dd>
1040
+ </dl>
1041
+
1042
+ <dl>
1043
+ <dd>
1044
+
1045
+ **requestOptions:** `OrganizationClient.RequestOptions`
1046
+
1047
+ </dd>
1048
+ </dl>
1049
+ </dd>
1050
+ </dl>
1051
+
1052
+
1053
+ </dd>
1054
+ </dl>
1055
+ </details>
1056
+
1057
+ ## Registry
1058
+ <details><summary><code>client.registry.<a href="/src/api/resources/registry/client/Client.ts">generateRegistryTokens</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.RegistryTokens, FernVenusApi.registry.generateRegistryTokens.Error&gt;</code></summary>
1059
+ <dl>
1060
+ <dd>
1061
+
1062
+ #### 🔌 Usage
1063
+
1064
+ <dl>
1065
+ <dd>
1066
+
1067
+ <dl>
1068
+ <dd>
1069
+
1070
+ ```typescript
1071
+ await client.registry.generateRegistryTokens({
1072
+ organizationId: "organizationId"
1073
+ });
1074
+
1075
+ ```
1076
+ </dd>
1077
+ </dl>
1078
+ </dd>
1079
+ </dl>
1080
+
1081
+ #### ⚙️ Parameters
1082
+
1083
+ <dl>
1084
+ <dd>
1085
+
1086
+ <dl>
1087
+ <dd>
1088
+
1089
+ **request:** `FernVenusApi.GenerateRegistryTokensRequest`
1090
+
1091
+ </dd>
1092
+ </dl>
1093
+
1094
+ <dl>
1095
+ <dd>
1096
+
1097
+ **requestOptions:** `RegistryClient.RequestOptions`
1098
+
1099
+ </dd>
1100
+ </dl>
1101
+ </dd>
1102
+ </dl>
1103
+
1104
+
1105
+ </dd>
1106
+ </dl>
1107
+ </details>
1108
+
1109
+ <details><summary><code>client.registry.<a href="/src/api/resources/registry/client/Client.ts">hasRegistryPermission</a>({ ...params }) -> core.APIResponse&lt;boolean, FernVenusApi.registry.hasRegistryPermission.Error&gt;</code></summary>
1110
+ <dl>
1111
+ <dd>
1112
+
1113
+ #### 🔌 Usage
1114
+
1115
+ <dl>
1116
+ <dd>
1117
+
1118
+ <dl>
1119
+ <dd>
1120
+
1121
+ ```typescript
1122
+ await client.registry.hasRegistryPermission({
1123
+ organizationId: "organizationId"
1124
+ });
1125
+
1126
+ ```
1127
+ </dd>
1128
+ </dl>
1129
+ </dd>
1130
+ </dl>
1131
+
1132
+ #### ⚙️ Parameters
1133
+
1134
+ <dl>
1135
+ <dd>
1136
+
1137
+ <dl>
1138
+ <dd>
1139
+
1140
+ **request:** `FernVenusApi.CheckRegistryPermissionRequest`
1141
+
1142
+ </dd>
1143
+ </dl>
1144
+
1145
+ <dl>
1146
+ <dd>
1147
+
1148
+ **requestOptions:** `RegistryClient.RequestOptions`
1149
+
1150
+ </dd>
1151
+ </dl>
1152
+ </dd>
1153
+ </dl>
1154
+
1155
+
1156
+ </dd>
1157
+ </dl>
1158
+ </details>
1159
+
1160
+ <details><summary><code>client.registry.<a href="/src/api/resources/registry/client/Client.ts">revokeToken</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.registry.revokeToken.Error&gt;</code></summary>
1161
+ <dl>
1162
+ <dd>
1163
+
1164
+ #### 🔌 Usage
1165
+
1166
+ <dl>
1167
+ <dd>
1168
+
1169
+ <dl>
1170
+ <dd>
1171
+
1172
+ ```typescript
1173
+ await client.registry.revokeToken({
1174
+ organizationId: "organizationId",
1175
+ token: "token"
1176
+ });
1177
+
1178
+ ```
1179
+ </dd>
1180
+ </dl>
1181
+ </dd>
1182
+ </dl>
1183
+
1184
+ #### ⚙️ Parameters
1185
+
1186
+ <dl>
1187
+ <dd>
1188
+
1189
+ <dl>
1190
+ <dd>
1191
+
1192
+ **request:** `FernVenusApi.RevokeTokenRequest`
1193
+
1194
+ </dd>
1195
+ </dl>
1196
+
1197
+ <dl>
1198
+ <dd>
1199
+
1200
+ **requestOptions:** `RegistryClient.RequestOptions`
1201
+
1202
+ </dd>
1203
+ </dl>
1204
+ </dd>
1205
+ </dl>
1206
+
1207
+
1208
+ </dd>
1209
+ </dl>
1210
+ </details>
1211
+
1212
+ ## User
1213
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getMyself</a>() -> core.APIResponse&lt;FernVenusApi.User, FernVenusApi.user.getMyself.Error&gt;</code></summary>
1214
+ <dl>
1215
+ <dd>
1216
+
1217
+ #### 🔌 Usage
1218
+
1219
+ <dl>
1220
+ <dd>
1221
+
1222
+ <dl>
1223
+ <dd>
1224
+
1225
+ ```typescript
1226
+ await client.user.getMyself();
1227
+
1228
+ ```
1229
+ </dd>
1230
+ </dl>
1231
+ </dd>
1232
+ </dl>
1233
+
1234
+ #### ⚙️ Parameters
1235
+
1236
+ <dl>
1237
+ <dd>
1238
+
1239
+ <dl>
1240
+ <dd>
1241
+
1242
+ **requestOptions:** `UserClient.RequestOptions`
1243
+
1244
+ </dd>
1245
+ </dl>
1246
+ </dd>
1247
+ </dl>
1248
+
1249
+
1250
+ </dd>
1251
+ </dl>
1252
+ </details>
1253
+
1254
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getMyOrganizations</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.OrganizationsPage, FernVenusApi.user.getMyOrganizations.Error&gt;</code></summary>
1255
+ <dl>
1256
+ <dd>
1257
+
1258
+ #### 🔌 Usage
1259
+
1260
+ <dl>
1261
+ <dd>
1262
+
1263
+ <dl>
1264
+ <dd>
1265
+
1266
+ ```typescript
1267
+ await client.user.getMyOrganizations({
1268
+ pageId: 1
1269
+ });
1270
+
1271
+ ```
1272
+ </dd>
1273
+ </dl>
1274
+ </dd>
1275
+ </dl>
1276
+
1277
+ #### ⚙️ Parameters
1278
+
1279
+ <dl>
1280
+ <dd>
1281
+
1282
+ <dl>
1283
+ <dd>
1284
+
1285
+ **request:** `FernVenusApi.GetUserOrganizationsRequest`
1286
+
1287
+ </dd>
1288
+ </dl>
1289
+
1290
+ <dl>
1291
+ <dd>
1292
+
1293
+ **requestOptions:** `UserClient.RequestOptions`
1294
+
1295
+ </dd>
1296
+ </dl>
1297
+ </dd>
1298
+ </dl>
1299
+
1300
+
1301
+ </dd>
1302
+ </dl>
1303
+ </details>
1304
+
1305
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">linkAccounts</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.LinkAccountsResponse, FernVenusApi.user.linkAccounts.Error&gt;</code></summary>
1306
+ <dl>
1307
+ <dd>
1308
+
1309
+ #### 📝 Description
1310
+
1311
+ <dl>
1312
+ <dd>
1313
+
1314
+ <dl>
1315
+ <dd>
1316
+
1317
+ Link user accounts with the same verified email address.
1318
+ Requires admin token authentication.
1319
+ </dd>
1320
+ </dl>
1321
+ </dd>
1322
+ </dl>
1323
+
1324
+ #### 🔌 Usage
1325
+
1326
+ <dl>
1327
+ <dd>
1328
+
1329
+ <dl>
1330
+ <dd>
1331
+
1332
+ ```typescript
1333
+ await client.user.linkAccounts({
1334
+ userId: "userId"
1335
+ });
1336
+
1337
+ ```
1338
+ </dd>
1339
+ </dl>
1340
+ </dd>
1341
+ </dl>
1342
+
1343
+ #### ⚙️ Parameters
1344
+
1345
+ <dl>
1346
+ <dd>
1347
+
1348
+ <dl>
1349
+ <dd>
1350
+
1351
+ **request:** `FernVenusApi.LinkAccountsRequest`
1352
+
1353
+ </dd>
1354
+ </dl>
1355
+
1356
+ <dl>
1357
+ <dd>
1358
+
1359
+ **requestOptions:** `UserClient.RequestOptions`
1360
+
1361
+ </dd>
1362
+ </dl>
1363
+ </dd>
1364
+ </dl>
1365
+
1366
+
1367
+ </dd>
1368
+ </dl>
1369
+ </details>