botshield-sdk 2.3.0 → 4.0.1

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 (405) hide show
  1. package/README.md +28 -2
  2. package/bin/mcp-server.js +1129 -52
  3. package/bin/mcp-server.js.map +34 -24
  4. package/dist/commonjs/funcs/actions-propose-action.d.ts +1 -1
  5. package/dist/commonjs/funcs/actions-propose-action.js +1 -1
  6. package/dist/commonjs/funcs/actions-verify-resolution.d.ts +18 -0
  7. package/dist/commonjs/funcs/actions-verify-resolution.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/actions-verify-resolution.js +129 -0
  9. package/dist/commonjs/funcs/actions-verify-resolution.js.map +1 -0
  10. package/dist/commonjs/funcs/census-confirm-link.d.ts +17 -0
  11. package/dist/commonjs/funcs/census-confirm-link.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/census-confirm-link.js +119 -0
  13. package/dist/commonjs/funcs/census-confirm-link.js.map +1 -0
  14. package/dist/commonjs/funcs/census-create-verification-link.d.ts +2 -0
  15. package/dist/commonjs/funcs/census-create-verification-link.d.ts.map +1 -1
  16. package/dist/commonjs/funcs/census-create-verification-link.js +2 -0
  17. package/dist/commonjs/funcs/census-create-verification-link.js.map +1 -1
  18. package/dist/commonjs/funcs/census-send-by-number.d.ts +18 -0
  19. package/dist/commonjs/funcs/census-send-by-number.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/census-send-by-number.js +123 -0
  21. package/dist/commonjs/funcs/census-send-by-number.js.map +1 -0
  22. package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
  23. package/dist/commonjs/funcs/census-verify-token.js +1 -1
  24. package/dist/commonjs/funcs/gates-actions-request-cancel.d.ts +18 -0
  25. package/dist/commonjs/funcs/gates-actions-request-cancel.d.ts.map +1 -0
  26. package/dist/commonjs/funcs/gates-actions-request-cancel.js +123 -0
  27. package/dist/commonjs/funcs/gates-actions-request-cancel.js.map +1 -0
  28. package/dist/commonjs/funcs/gates-actions-request-status.js +1 -0
  29. package/dist/commonjs/funcs/gates-actions-request-status.js.map +1 -1
  30. package/dist/commonjs/funcs/gates-actions-request.d.ts +1 -1
  31. package/dist/commonjs/funcs/gates-actions-request.js +1 -1
  32. package/dist/commonjs/funcs/gates-actions-update.d.ts +18 -0
  33. package/dist/commonjs/funcs/gates-actions-update.d.ts.map +1 -0
  34. package/dist/commonjs/funcs/gates-actions-update.js +123 -0
  35. package/dist/commonjs/funcs/gates-actions-update.js.map +1 -0
  36. package/dist/commonjs/funcs/recovery-exchange.d.ts +18 -0
  37. package/dist/commonjs/funcs/recovery-exchange.d.ts.map +1 -0
  38. package/dist/commonjs/funcs/recovery-exchange.js +123 -0
  39. package/dist/commonjs/funcs/recovery-exchange.js.map +1 -0
  40. package/dist/commonjs/funcs/recovery-other-route.d.ts +18 -0
  41. package/dist/commonjs/funcs/recovery-other-route.d.ts.map +1 -0
  42. package/dist/commonjs/funcs/recovery-other-route.js +123 -0
  43. package/dist/commonjs/funcs/recovery-other-route.js.map +1 -0
  44. package/dist/commonjs/funcs/sign-in-confirm.d.ts +18 -0
  45. package/dist/commonjs/funcs/sign-in-confirm.d.ts.map +1 -0
  46. package/dist/commonjs/funcs/sign-in-confirm.js +123 -0
  47. package/dist/commonjs/funcs/sign-in-confirm.js.map +1 -0
  48. package/dist/commonjs/funcs/sign-in-request.d.ts +18 -0
  49. package/dist/commonjs/funcs/sign-in-request.d.ts.map +1 -0
  50. package/dist/commonjs/funcs/sign-in-request.js +123 -0
  51. package/dist/commonjs/funcs/sign-in-request.js.map +1 -0
  52. package/dist/commonjs/funcs/verification-get-status.d.ts +1 -1
  53. package/dist/commonjs/funcs/verification-get-status.js +2 -1
  54. package/dist/commonjs/funcs/verification-get-status.js.map +1 -1
  55. package/dist/commonjs/lib/config.d.ts +2 -2
  56. package/dist/commonjs/lib/config.js +2 -2
  57. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  58. package/dist/commonjs/mcp-server/server.js +1 -1
  59. package/dist/commonjs/models/bot-shield-action.d.ts +46 -0
  60. package/dist/commonjs/models/bot-shield-action.d.ts.map +1 -1
  61. package/dist/commonjs/models/bot-shield-action.js +36 -1
  62. package/dist/commonjs/models/bot-shield-action.js.map +1 -1
  63. package/dist/commonjs/models/error-body.d.ts +6 -1
  64. package/dist/commonjs/models/error-body.d.ts.map +1 -1
  65. package/dist/commonjs/models/error-body.js +4 -0
  66. package/dist/commonjs/models/error-body.js.map +1 -1
  67. package/dist/commonjs/models/gate-unavailable-event.d.ts +112 -0
  68. package/dist/commonjs/models/gate-unavailable-event.d.ts.map +1 -0
  69. package/dist/commonjs/models/gate-unavailable-event.js +137 -0
  70. package/dist/commonjs/models/gate-unavailable-event.js.map +1 -0
  71. package/dist/commonjs/models/gates-api-error.d.ts +5 -0
  72. package/dist/commonjs/models/gates-api-error.d.ts.map +1 -1
  73. package/dist/commonjs/models/gates-api-error.js +11 -0
  74. package/dist/commonjs/models/gates-api-error.js.map +1 -1
  75. package/dist/commonjs/models/index.d.ts +1 -0
  76. package/dist/commonjs/models/index.d.ts.map +1 -1
  77. package/dist/commonjs/models/index.js +1 -0
  78. package/dist/commonjs/models/index.js.map +1 -1
  79. package/dist/commonjs/models/operations/actions-propose.d.ts +21 -1
  80. package/dist/commonjs/models/operations/actions-propose.d.ts.map +1 -1
  81. package/dist/commonjs/models/operations/actions-propose.js +16 -0
  82. package/dist/commonjs/models/operations/actions-propose.js.map +1 -1
  83. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +11 -1
  84. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts.map +1 -1
  85. package/dist/commonjs/models/operations/gates-api-actions-create.js +4 -0
  86. package/dist/commonjs/models/operations/gates-api-actions-create.js.map +1 -1
  87. package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
  88. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  89. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  90. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js +178 -0
  91. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  92. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts +5 -0
  93. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  94. package/dist/commonjs/models/operations/gates-api-actions-request-status.js +2 -0
  95. package/dist/commonjs/models/operations/gates-api-actions-request-status.js.map +1 -1
  96. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +34 -4
  97. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts.map +1 -1
  98. package/dist/commonjs/models/operations/gates-api-actions-request.js +32 -3
  99. package/dist/commonjs/models/operations/gates-api-actions-request.js.map +1 -1
  100. package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
  101. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +99 -0
  102. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts.map +1 -0
  103. package/dist/commonjs/models/operations/gates-api-actions-update.js +141 -0
  104. package/dist/commonjs/models/operations/gates-api-actions-update.js.map +1 -0
  105. package/dist/commonjs/models/operations/index.d.ts +9 -0
  106. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  107. package/dist/commonjs/models/operations/index.js +9 -0
  108. package/dist/commonjs/models/operations/index.js.map +1 -1
  109. package/dist/commonjs/models/operations/recovery-exchange.d.ts +114 -0
  110. package/dist/commonjs/models/operations/recovery-exchange.d.ts.map +1 -0
  111. package/dist/commonjs/models/operations/recovery-exchange.js +164 -0
  112. package/dist/commonjs/models/operations/recovery-exchange.js.map +1 -0
  113. package/dist/commonjs/models/operations/recovery-other-route.d.ts +86 -0
  114. package/dist/commonjs/models/operations/recovery-other-route.d.ts.map +1 -0
  115. package/dist/commonjs/models/operations/recovery-other-route.js +145 -0
  116. package/dist/commonjs/models/operations/recovery-other-route.js.map +1 -0
  117. package/dist/commonjs/models/operations/request-passkey-complete.d.ts +1 -1
  118. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts +130 -0
  119. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts.map +1 -0
  120. package/dist/commonjs/models/operations/sdk-confirm-link.js +205 -0
  121. package/dist/commonjs/models/operations/sdk-confirm-link.js.map +1 -0
  122. package/dist/commonjs/models/operations/sdk-create-session.d.ts +1 -1
  123. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +48 -2
  124. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  125. package/dist/commonjs/models/operations/sdk-create-verification-link.js +34 -1
  126. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  127. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +124 -0
  128. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts.map +1 -0
  129. package/dist/commonjs/models/operations/sdk-send-by-number.js +203 -0
  130. package/dist/commonjs/models/operations/sdk-send-by-number.js.map +1 -0
  131. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts +125 -0
  132. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  133. package/dist/commonjs/models/operations/sdk-verify-resolution.js +182 -0
  134. package/dist/commonjs/models/operations/sdk-verify-resolution.js.map +1 -0
  135. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +110 -1
  136. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  137. package/dist/commonjs/models/operations/sdk-verify-token.js +96 -1
  138. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  139. package/dist/commonjs/models/operations/signin-confirm.d.ts +148 -0
  140. package/dist/commonjs/models/operations/signin-confirm.d.ts.map +1 -0
  141. package/dist/commonjs/models/operations/signin-confirm.js +202 -0
  142. package/dist/commonjs/models/operations/signin-confirm.js.map +1 -0
  143. package/dist/commonjs/models/operations/signin-request.d.ts +115 -0
  144. package/dist/commonjs/models/operations/signin-request.d.ts.map +1 -0
  145. package/dist/commonjs/models/operations/signin-request.js +174 -0
  146. package/dist/commonjs/models/operations/signin-request.js.map +1 -0
  147. package/dist/commonjs/models/operations/verification-get-status.d.ts +45 -5
  148. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  149. package/dist/commonjs/models/operations/verification-get-status.js +37 -2
  150. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  151. package/dist/commonjs/models/passes-per-person.d.ts +1 -1
  152. package/dist/commonjs/sdk/actions.d.ts +8 -1
  153. package/dist/commonjs/sdk/actions.d.ts.map +1 -1
  154. package/dist/commonjs/sdk/actions.js +11 -1
  155. package/dist/commonjs/sdk/actions.js.map +1 -1
  156. package/dist/commonjs/sdk/census.d.ts +17 -1
  157. package/dist/commonjs/sdk/census.d.ts.map +1 -1
  158. package/dist/commonjs/sdk/census.js +23 -1
  159. package/dist/commonjs/sdk/census.js.map +1 -1
  160. package/dist/commonjs/sdk/gates-actions.d.ts +15 -1
  161. package/dist/commonjs/sdk/gates-actions.d.ts.map +1 -1
  162. package/dist/commonjs/sdk/gates-actions.js +21 -1
  163. package/dist/commonjs/sdk/gates-actions.js.map +1 -1
  164. package/dist/commonjs/sdk/recovery.d.ts +19 -0
  165. package/dist/commonjs/sdk/recovery.d.ts.map +1 -0
  166. package/dist/commonjs/sdk/recovery.js +32 -0
  167. package/dist/commonjs/sdk/recovery.js.map +1 -0
  168. package/dist/commonjs/sdk/sdk.d.ts +8 -2
  169. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  170. package/dist/commonjs/sdk/sdk.js +14 -4
  171. package/dist/commonjs/sdk/sdk.js.map +1 -1
  172. package/dist/commonjs/sdk/sign-in.d.ts +19 -0
  173. package/dist/commonjs/sdk/sign-in.d.ts.map +1 -0
  174. package/dist/commonjs/sdk/sign-in.js +32 -0
  175. package/dist/commonjs/sdk/sign-in.js.map +1 -0
  176. package/dist/commonjs/sdk/verification.d.ts +1 -1
  177. package/dist/commonjs/sdk/verification.js +1 -1
  178. package/dist/esm/funcs/actions-propose-action.d.ts +1 -1
  179. package/dist/esm/funcs/actions-propose-action.js +1 -1
  180. package/dist/esm/funcs/actions-verify-resolution.d.ts +18 -0
  181. package/dist/esm/funcs/actions-verify-resolution.d.ts.map +1 -0
  182. package/dist/esm/funcs/actions-verify-resolution.js +93 -0
  183. package/dist/esm/funcs/actions-verify-resolution.js.map +1 -0
  184. package/dist/esm/funcs/census-confirm-link.d.ts +17 -0
  185. package/dist/esm/funcs/census-confirm-link.d.ts.map +1 -0
  186. package/dist/esm/funcs/census-confirm-link.js +83 -0
  187. package/dist/esm/funcs/census-confirm-link.js.map +1 -0
  188. package/dist/esm/funcs/census-create-verification-link.d.ts +2 -0
  189. package/dist/esm/funcs/census-create-verification-link.d.ts.map +1 -1
  190. package/dist/esm/funcs/census-create-verification-link.js +2 -0
  191. package/dist/esm/funcs/census-create-verification-link.js.map +1 -1
  192. package/dist/esm/funcs/census-send-by-number.d.ts +18 -0
  193. package/dist/esm/funcs/census-send-by-number.d.ts.map +1 -0
  194. package/dist/esm/funcs/census-send-by-number.js +87 -0
  195. package/dist/esm/funcs/census-send-by-number.js.map +1 -0
  196. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  197. package/dist/esm/funcs/census-verify-token.js +1 -1
  198. package/dist/esm/funcs/gates-actions-request-cancel.d.ts +18 -0
  199. package/dist/esm/funcs/gates-actions-request-cancel.d.ts.map +1 -0
  200. package/dist/esm/funcs/gates-actions-request-cancel.js +87 -0
  201. package/dist/esm/funcs/gates-actions-request-cancel.js.map +1 -0
  202. package/dist/esm/funcs/gates-actions-request-status.js +1 -0
  203. package/dist/esm/funcs/gates-actions-request-status.js.map +1 -1
  204. package/dist/esm/funcs/gates-actions-request.d.ts +1 -1
  205. package/dist/esm/funcs/gates-actions-request.js +1 -1
  206. package/dist/esm/funcs/gates-actions-update.d.ts +18 -0
  207. package/dist/esm/funcs/gates-actions-update.d.ts.map +1 -0
  208. package/dist/esm/funcs/gates-actions-update.js +87 -0
  209. package/dist/esm/funcs/gates-actions-update.js.map +1 -0
  210. package/dist/esm/funcs/recovery-exchange.d.ts +18 -0
  211. package/dist/esm/funcs/recovery-exchange.d.ts.map +1 -0
  212. package/dist/esm/funcs/recovery-exchange.js +87 -0
  213. package/dist/esm/funcs/recovery-exchange.js.map +1 -0
  214. package/dist/esm/funcs/recovery-other-route.d.ts +18 -0
  215. package/dist/esm/funcs/recovery-other-route.d.ts.map +1 -0
  216. package/dist/esm/funcs/recovery-other-route.js +87 -0
  217. package/dist/esm/funcs/recovery-other-route.js.map +1 -0
  218. package/dist/esm/funcs/sign-in-confirm.d.ts +18 -0
  219. package/dist/esm/funcs/sign-in-confirm.d.ts.map +1 -0
  220. package/dist/esm/funcs/sign-in-confirm.js +87 -0
  221. package/dist/esm/funcs/sign-in-confirm.js.map +1 -0
  222. package/dist/esm/funcs/sign-in-request.d.ts +18 -0
  223. package/dist/esm/funcs/sign-in-request.d.ts.map +1 -0
  224. package/dist/esm/funcs/sign-in-request.js +87 -0
  225. package/dist/esm/funcs/sign-in-request.js.map +1 -0
  226. package/dist/esm/funcs/verification-get-status.d.ts +1 -1
  227. package/dist/esm/funcs/verification-get-status.js +3 -2
  228. package/dist/esm/funcs/verification-get-status.js.map +1 -1
  229. package/dist/esm/lib/config.d.ts +2 -2
  230. package/dist/esm/lib/config.js +2 -2
  231. package/dist/esm/mcp-server/mcp-server.js +1 -1
  232. package/dist/esm/mcp-server/server.js +1 -1
  233. package/dist/esm/models/bot-shield-action.d.ts +46 -0
  234. package/dist/esm/models/bot-shield-action.d.ts.map +1 -1
  235. package/dist/esm/models/bot-shield-action.js +35 -0
  236. package/dist/esm/models/bot-shield-action.js.map +1 -1
  237. package/dist/esm/models/error-body.d.ts +6 -1
  238. package/dist/esm/models/error-body.d.ts.map +1 -1
  239. package/dist/esm/models/error-body.js +4 -0
  240. package/dist/esm/models/error-body.js.map +1 -1
  241. package/dist/esm/models/gate-unavailable-event.d.ts +112 -0
  242. package/dist/esm/models/gate-unavailable-event.d.ts.map +1 -0
  243. package/dist/esm/models/gate-unavailable-event.js +99 -0
  244. package/dist/esm/models/gate-unavailable-event.js.map +1 -0
  245. package/dist/esm/models/gates-api-error.d.ts +5 -0
  246. package/dist/esm/models/gates-api-error.d.ts.map +1 -1
  247. package/dist/esm/models/gates-api-error.js +11 -0
  248. package/dist/esm/models/gates-api-error.js.map +1 -1
  249. package/dist/esm/models/index.d.ts +1 -0
  250. package/dist/esm/models/index.d.ts.map +1 -1
  251. package/dist/esm/models/index.js +1 -0
  252. package/dist/esm/models/index.js.map +1 -1
  253. package/dist/esm/models/operations/actions-propose.d.ts +21 -1
  254. package/dist/esm/models/operations/actions-propose.d.ts.map +1 -1
  255. package/dist/esm/models/operations/actions-propose.js +16 -0
  256. package/dist/esm/models/operations/actions-propose.js.map +1 -1
  257. package/dist/esm/models/operations/gates-api-actions-create.d.ts +11 -1
  258. package/dist/esm/models/operations/gates-api-actions-create.d.ts.map +1 -1
  259. package/dist/esm/models/operations/gates-api-actions-create.js +4 -0
  260. package/dist/esm/models/operations/gates-api-actions-create.js.map +1 -1
  261. package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
  262. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  263. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  264. package/dist/esm/models/operations/gates-api-actions-request-cancel.js +132 -0
  265. package/dist/esm/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  266. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts +5 -0
  267. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  268. package/dist/esm/models/operations/gates-api-actions-request-status.js +2 -0
  269. package/dist/esm/models/operations/gates-api-actions-request-status.js.map +1 -1
  270. package/dist/esm/models/operations/gates-api-actions-request.d.ts +34 -4
  271. package/dist/esm/models/operations/gates-api-actions-request.d.ts.map +1 -1
  272. package/dist/esm/models/operations/gates-api-actions-request.js +29 -2
  273. package/dist/esm/models/operations/gates-api-actions-request.js.map +1 -1
  274. package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
  275. package/dist/esm/models/operations/gates-api-actions-update.d.ts +99 -0
  276. package/dist/esm/models/operations/gates-api-actions-update.d.ts.map +1 -0
  277. package/dist/esm/models/operations/gates-api-actions-update.js +95 -0
  278. package/dist/esm/models/operations/gates-api-actions-update.js.map +1 -0
  279. package/dist/esm/models/operations/index.d.ts +9 -0
  280. package/dist/esm/models/operations/index.d.ts.map +1 -1
  281. package/dist/esm/models/operations/index.js +9 -0
  282. package/dist/esm/models/operations/index.js.map +1 -1
  283. package/dist/esm/models/operations/recovery-exchange.d.ts +114 -0
  284. package/dist/esm/models/operations/recovery-exchange.d.ts.map +1 -0
  285. package/dist/esm/models/operations/recovery-exchange.js +118 -0
  286. package/dist/esm/models/operations/recovery-exchange.js.map +1 -0
  287. package/dist/esm/models/operations/recovery-other-route.d.ts +86 -0
  288. package/dist/esm/models/operations/recovery-other-route.d.ts.map +1 -0
  289. package/dist/esm/models/operations/recovery-other-route.js +99 -0
  290. package/dist/esm/models/operations/recovery-other-route.js.map +1 -0
  291. package/dist/esm/models/operations/request-passkey-complete.d.ts +1 -1
  292. package/dist/esm/models/operations/sdk-confirm-link.d.ts +130 -0
  293. package/dist/esm/models/operations/sdk-confirm-link.d.ts.map +1 -0
  294. package/dist/esm/models/operations/sdk-confirm-link.js +157 -0
  295. package/dist/esm/models/operations/sdk-confirm-link.js.map +1 -0
  296. package/dist/esm/models/operations/sdk-create-session.d.ts +1 -1
  297. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +48 -2
  298. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  299. package/dist/esm/models/operations/sdk-create-verification-link.js +33 -0
  300. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  301. package/dist/esm/models/operations/sdk-send-by-number.d.ts +124 -0
  302. package/dist/esm/models/operations/sdk-send-by-number.d.ts.map +1 -0
  303. package/dist/esm/models/operations/sdk-send-by-number.js +155 -0
  304. package/dist/esm/models/operations/sdk-send-by-number.js.map +1 -0
  305. package/dist/esm/models/operations/sdk-verify-resolution.d.ts +125 -0
  306. package/dist/esm/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  307. package/dist/esm/models/operations/sdk-verify-resolution.js +136 -0
  308. package/dist/esm/models/operations/sdk-verify-resolution.js.map +1 -0
  309. package/dist/esm/models/operations/sdk-verify-token.d.ts +110 -1
  310. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  311. package/dist/esm/models/operations/sdk-verify-token.js +93 -0
  312. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  313. package/dist/esm/models/operations/signin-confirm.d.ts +148 -0
  314. package/dist/esm/models/operations/signin-confirm.d.ts.map +1 -0
  315. package/dist/esm/models/operations/signin-confirm.js +156 -0
  316. package/dist/esm/models/operations/signin-confirm.js.map +1 -0
  317. package/dist/esm/models/operations/signin-request.d.ts +115 -0
  318. package/dist/esm/models/operations/signin-request.d.ts.map +1 -0
  319. package/dist/esm/models/operations/signin-request.js +128 -0
  320. package/dist/esm/models/operations/signin-request.js.map +1 -0
  321. package/dist/esm/models/operations/verification-get-status.d.ts +45 -5
  322. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  323. package/dist/esm/models/operations/verification-get-status.js +36 -1
  324. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  325. package/dist/esm/models/passes-per-person.d.ts +1 -1
  326. package/dist/esm/sdk/actions.d.ts +8 -1
  327. package/dist/esm/sdk/actions.d.ts.map +1 -1
  328. package/dist/esm/sdk/actions.js +11 -1
  329. package/dist/esm/sdk/actions.js.map +1 -1
  330. package/dist/esm/sdk/census.d.ts +17 -1
  331. package/dist/esm/sdk/census.d.ts.map +1 -1
  332. package/dist/esm/sdk/census.js +23 -1
  333. package/dist/esm/sdk/census.js.map +1 -1
  334. package/dist/esm/sdk/gates-actions.d.ts +15 -1
  335. package/dist/esm/sdk/gates-actions.d.ts.map +1 -1
  336. package/dist/esm/sdk/gates-actions.js +21 -1
  337. package/dist/esm/sdk/gates-actions.js.map +1 -1
  338. package/dist/esm/sdk/recovery.d.ts +19 -0
  339. package/dist/esm/sdk/recovery.d.ts.map +1 -0
  340. package/dist/esm/sdk/recovery.js +28 -0
  341. package/dist/esm/sdk/recovery.js.map +1 -0
  342. package/dist/esm/sdk/sdk.d.ts +8 -2
  343. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  344. package/dist/esm/sdk/sdk.js +14 -4
  345. package/dist/esm/sdk/sdk.js.map +1 -1
  346. package/dist/esm/sdk/sign-in.d.ts +19 -0
  347. package/dist/esm/sdk/sign-in.d.ts.map +1 -0
  348. package/dist/esm/sdk/sign-in.js +28 -0
  349. package/dist/esm/sdk/sign-in.js.map +1 -0
  350. package/dist/esm/sdk/verification.d.ts +1 -1
  351. package/dist/esm/sdk/verification.js +1 -1
  352. package/jsr.json +1 -1
  353. package/package.json +1 -1
  354. package/src/funcs/actions-propose-action.ts +1 -1
  355. package/src/funcs/actions-verify-resolution.ts +192 -0
  356. package/src/funcs/census-confirm-link.ts +171 -0
  357. package/src/funcs/census-create-verification-link.ts +2 -0
  358. package/src/funcs/census-send-by-number.ts +180 -0
  359. package/src/funcs/census-verify-token.ts +1 -1
  360. package/src/funcs/gates-actions-request-cancel.ts +187 -0
  361. package/src/funcs/gates-actions-request-status.ts +1 -0
  362. package/src/funcs/gates-actions-request.ts +1 -1
  363. package/src/funcs/gates-actions-update.ts +185 -0
  364. package/src/funcs/recovery-exchange.ts +184 -0
  365. package/src/funcs/recovery-other-route.ts +184 -0
  366. package/src/funcs/sign-in-confirm.ts +184 -0
  367. package/src/funcs/sign-in-request.ts +184 -0
  368. package/src/funcs/verification-get-status.ts +7 -2
  369. package/src/lib/config.ts +2 -2
  370. package/src/mcp-server/mcp-server.ts +1 -1
  371. package/src/mcp-server/server.ts +1 -1
  372. package/src/models/bot-shield-action.ts +79 -0
  373. package/src/models/error-body.ts +10 -1
  374. package/src/models/gate-unavailable-event.ts +218 -0
  375. package/src/models/gates-api-error.ts +16 -0
  376. package/src/models/index.ts +1 -0
  377. package/src/models/operations/actions-propose.ts +37 -1
  378. package/src/models/operations/gates-api-actions-create.ts +15 -1
  379. package/src/models/operations/gates-api-actions-list.ts +1 -1
  380. package/src/models/operations/gates-api-actions-request-cancel.ts +339 -0
  381. package/src/models/operations/gates-api-actions-request-status.ts +7 -0
  382. package/src/models/operations/gates-api-actions-request.ts +83 -6
  383. package/src/models/operations/gates-api-actions-set-state.ts +1 -1
  384. package/src/models/operations/gates-api-actions-update.ts +281 -0
  385. package/src/models/operations/index.ts +9 -0
  386. package/src/models/operations/recovery-exchange.ts +308 -0
  387. package/src/models/operations/recovery-other-route.ts +262 -0
  388. package/src/models/operations/request-passkey-complete.ts +1 -1
  389. package/src/models/operations/sdk-confirm-link.ts +380 -0
  390. package/src/models/operations/sdk-create-session.ts +1 -1
  391. package/src/models/operations/sdk-create-verification-link.ts +78 -2
  392. package/src/models/operations/sdk-send-by-number.ts +372 -0
  393. package/src/models/operations/sdk-verify-resolution.ts +341 -0
  394. package/src/models/operations/sdk-verify-token.ts +214 -1
  395. package/src/models/operations/signin-confirm.ts +383 -0
  396. package/src/models/operations/signin-request.ts +319 -0
  397. package/src/models/operations/verification-get-status.ts +76 -5
  398. package/src/models/passes-per-person.ts +1 -1
  399. package/src/sdk/actions.ts +21 -1
  400. package/src/sdk/census.ts +43 -1
  401. package/src/sdk/gates-actions.ts +41 -1
  402. package/src/sdk/recovery.ts +49 -0
  403. package/src/sdk/sdk.ts +17 -5
  404. package/src/sdk/sign-in.ts +49 -0
  405. package/src/sdk/verification.ts +1 -1
@@ -6,21 +6,23 @@ import { Actions } from "./actions.js";
6
6
  import { Census } from "./census.js";
7
7
  import { Gates } from "./gates.js";
8
8
  import { InlinePasskey } from "./inline-passkey.js";
9
+ import { Recovery } from "./recovery.js";
9
10
  import { SecuredAccounts } from "./secured-accounts.js";
11
+ import { SignIn } from "./sign-in.js";
10
12
  import { Verification } from "./verification.js";
11
13
  export class BotShield extends ClientSDK {
12
14
  _census;
13
15
  get census() {
14
16
  return (this._census ?? (this._census = new Census(this._options)));
15
17
  }
16
- _verification;
17
- get verification() {
18
- return (this._verification ?? (this._verification = new Verification(this._options)));
19
- }
20
18
  _actions;
21
19
  get actions() {
22
20
  return (this._actions ?? (this._actions = new Actions(this._options)));
23
21
  }
22
+ _verification;
23
+ get verification() {
24
+ return (this._verification ?? (this._verification = new Verification(this._options)));
25
+ }
24
26
  _securedAccounts;
25
27
  get securedAccounts() {
26
28
  return (this._securedAccounts ?? (this._securedAccounts = new SecuredAccounts(this._options)));
@@ -33,5 +35,13 @@ export class BotShield extends ClientSDK {
33
35
  get inlinePasskey() {
34
36
  return (this._inlinePasskey ?? (this._inlinePasskey = new InlinePasskey(this._options)));
35
37
  }
38
+ _recovery;
39
+ get recovery() {
40
+ return (this._recovery ?? (this._recovery = new Recovery(this._options)));
41
+ }
42
+ _signIn;
43
+ get signIn() {
44
+ return (this._signIn ?? (this._signIn = new SignIn(this._options)));
45
+ }
36
46
  }
37
47
  //# sourceMappingURL=sdk.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,OAAO,SAAU,SAAQ,SAAS;IAC9B,OAAO,CAAU;IACzB,IAAI,MAAM,GAAW;QACnB,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACrD;IAEO,aAAa,CAAgB;IACrC,IAAI,YAAY,GAAiB;QAC/B,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACjE;IAEO,QAAQ,CAAW;IAC3B,IAAI,OAAO,GAAY;QACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvD;IAEO,gBAAgB,CAAmB;IAC3C,IAAI,eAAe,GAAoB;QACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvE;IAEO,MAAM,CAAS;IACvB,IAAI,KAAK,GAAU;QACjB,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnD;IAEO,cAAc,CAAiB;IACvC,IAAI,aAAa,GAAkB;QACjC,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnE;CACF"}
1
+ {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,OAAO,SAAU,SAAQ,SAAS;IAC9B,OAAO,CAAU;IACzB,IAAI,MAAM,GAAW;QACnB,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACrD;IAEO,QAAQ,CAAW;IAC3B,IAAI,OAAO,GAAY;QACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvD;IAEO,aAAa,CAAgB;IACrC,IAAI,YAAY,GAAiB;QAC/B,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACjE;IAEO,gBAAgB,CAAmB;IAC3C,IAAI,eAAe,GAAoB;QACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvE;IAEO,MAAM,CAAS;IACvB,IAAI,KAAK,GAAU;QACjB,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnD;IAEO,cAAc,CAAiB;IACvC,IAAI,aAAa,GAAkB;QACjC,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnE;IAEO,SAAS,CAAY;IAC7B,IAAI,QAAQ,GAAa;QACvB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACzD;IAEO,OAAO,CAAU;IACzB,IAAI,MAAM,GAAW;QACnB,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACrD;CACF"}
@@ -0,0 +1,19 @@
1
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
2
+ import * as operations from "../models/operations/index.js";
3
+ export declare class SignIn extends ClientSDK {
4
+ /**
5
+ * Ask for a passkey sign-in
6
+ *
7
+ * @remarks
8
+ * Your SERVER asks for a sign-in for ONE of your accounts, after the password has passed or after the customer named their account. Hand the page only `request_id`. Answers only for an account that is already an active verified account here; otherwise `not_verified`, nothing is started, and you do not show the button. It never links an account. A paused account is refused (`account_paused`). The request lives 2 minutes. Needs a live Sign-on Action with your sign-in page's address (BotShield Console › Verified Accounts › BotShield Actions).
9
+ */
10
+ request(security: operations.SigninRequestSecurity, request: operations.SigninRequestRequest, options?: RequestOptions): Promise<operations.SigninRequestResponse>;
11
+ /**
12
+ * Redeem a passkey sign-in
13
+ *
14
+ * @remarks
15
+ * Your SERVER redeems a sign-in with your secret key and the `request_id` IT made for this attempt: once, within 2 minutes of the passkey. The page's message from the frame is only a cue to call this. Send `partner_user_ref` to have a sign-in for any other account refused. The sign-in's token is not checked with verify-token (which refuses it), and verification/status never returns it.
16
+ */
17
+ confirm(security: operations.SigninConfirmSecurity, request: operations.SigninConfirmRequest, options?: RequestOptions): Promise<operations.SigninConfirmResponse>;
18
+ }
19
+ //# sourceMappingURL=sign-in.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-in.d.ts","sourceRoot":"","sources":["../../../src/sdk/sign-in.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACG,OAAO,CACX,QAAQ,EAAE,UAAU,CAAC,qBAAqB,EAC1C,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAO3C;IAED;;;;;OAKG;IACG,OAAO,CACX,QAAQ,EAAE,UAAU,CAAC,qBAAqB,EAC1C,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAO3C;CACF"}
@@ -0,0 +1,28 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import { signInConfirm } from "../funcs/sign-in-confirm.js";
5
+ import { signInRequest } from "../funcs/sign-in-request.js";
6
+ import { ClientSDK } from "../lib/sdks.js";
7
+ import { unwrapAsync } from "../types/fp.js";
8
+ export class SignIn extends ClientSDK {
9
+ /**
10
+ * Ask for a passkey sign-in
11
+ *
12
+ * @remarks
13
+ * Your SERVER asks for a sign-in for ONE of your accounts, after the password has passed or after the customer named their account. Hand the page only `request_id`. Answers only for an account that is already an active verified account here; otherwise `not_verified`, nothing is started, and you do not show the button. It never links an account. A paused account is refused (`account_paused`). The request lives 2 minutes. Needs a live Sign-on Action with your sign-in page's address (BotShield Console › Verified Accounts › BotShield Actions).
14
+ */
15
+ async request(security, request, options) {
16
+ return unwrapAsync(signInRequest(this, security, request, options));
17
+ }
18
+ /**
19
+ * Redeem a passkey sign-in
20
+ *
21
+ * @remarks
22
+ * Your SERVER redeems a sign-in with your secret key and the `request_id` IT made for this attempt: once, within 2 minutes of the passkey. The page's message from the frame is only a cue to call this. Send `partner_user_ref` to have a sign-in for any other account refused. The sign-in's token is not checked with verify-token (which refuses it), and verification/status never returns it.
23
+ */
24
+ async confirm(security, request, options) {
25
+ return unwrapAsync(signInConfirm(this, security, request, options));
26
+ }
27
+ }
28
+ //# sourceMappingURL=sign-in.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-in.js","sourceRoot":"","sources":["../../../src/sdk/sign-in.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,QAA0C,EAC1C,OAAwC,EACxC,OAAwB,EACmB;QAC3C,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,QAA0C,EAC1C,OAAwC,EACxC,OAAwB,EACmB;QAC3C,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;CACF"}
@@ -5,7 +5,7 @@ export declare class Verification extends ClientSDK {
5
5
  * Check verification status
6
6
  *
7
7
  * @remarks
8
- * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary.
8
+ * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. 4.0: knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
9
9
  */
10
10
  getStatus(security: operations.VerificationGetStatusSecurity, request: operations.VerificationGetStatusRequest, options?: RequestOptions): Promise<operations.VerificationGetStatusResponse>;
11
11
  }
@@ -9,7 +9,7 @@ export class Verification extends ClientSDK {
9
9
  * Check verification status
10
10
  *
11
11
  * @remarks
12
- * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary.
12
+ * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. 4.0: knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
13
13
  */
14
14
  async getStatus(security, request, options) {
15
15
  return unwrapAsync(verificationGetStatus(this, security, request, options));
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "botshield-sdk",
5
- "version": "2.3.0",
5
+ "version": "4.0.1",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "botshield-sdk",
3
- "version": "2.3.0",
3
+ "version": "4.0.1",
4
4
  "author": "BotShield",
5
5
  "description": "Official TypeScript SDK for BotShield — privacy-first human verification (passkeys, no PII) and Agents Ask approvals",
6
6
  "homepage": "https://docs.botshield.ai",
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
30
30
  * Propose an action for human confirmation
31
31
  *
32
32
  * @remarks
33
- * Queue a human-presence-gated action for a BotShield user. The user receives the card in the BotShield app (Agents Ask), confirms or denies with their passkey, and BotShield delivers a signed Proof of Resolution JWT to your registered callback URL (or poll check-status). Identify the user by opaque_id — the pairwise id from the bind ceremony. Authentication: agent key (bs_agent_<name>__<secret>) in the Authorization header.
33
+ * Queue a human-presence-gated action for a BotShield user. The user receives the card in the BotShield app (Agents Ask), confirms or denies with their passkey, and BotShield delivers a signed Proof of Resolution JWT to your registered callback URL (or poll check-status). Identify the user by opaque_id — the pairwise id from the bind ceremony. Authentication: agent key (bs_agent_<name>__<secret>) in the Authorization header. Or address the person by `phone_number` (no link needed beforehand; see the field).
34
34
  */
35
35
  export function actionsProposeAction(
36
36
  client: BotShieldCore,
@@ -0,0 +1,192 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { BotShieldCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { resolveSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import { BotShieldError } from "../models/errors/bot-shield-error.js";
15
+ import {
16
+ ConnectionError,
17
+ InvalidRequestError,
18
+ RequestAbortedError,
19
+ RequestTimeoutError,
20
+ UnexpectedClientError,
21
+ } from "../models/errors/http-client-errors.js";
22
+ import * as errors from "../models/errors/index.js";
23
+ import { ResponseValidationError } from "../models/errors/response-validation-error.js";
24
+ import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
25
+ import * as operations from "../models/operations/index.js";
26
+ import { APICall, APIPromise } from "../types/async.js";
27
+ import { Result } from "../types/fp.js";
28
+
29
+ /**
30
+ * Check a Proof of Resolution (works once)
31
+ *
32
+ * @remarks
33
+ * An approved ask mints a proof that the agent reads with agentlink/check-status. Send it here before acting on it. The first check answers valid true with what was approved; every later check answers valid false with replayed true. Checking the signature yourself against the public keys shows the proof is real, not that it is unused. Call with the agent's own key (for a proof minted for that agent) or the company's secret key (for a proof minted for one of its agents).
34
+ */
35
+ export function actionsVerifyResolution(
36
+ client: BotShieldCore,
37
+ security: operations.SDKVerifyResolutionSecurity,
38
+ request: operations.SDKVerifyResolutionRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.SDKVerifyResolutionResponse,
43
+ | errors.InvalidInputError
44
+ | errors.ErrorResponse
45
+ | BotShieldError
46
+ | ResponseValidationError
47
+ | ConnectionError
48
+ | RequestAbortedError
49
+ | RequestTimeoutError
50
+ | InvalidRequestError
51
+ | UnexpectedClientError
52
+ | SDKValidationError
53
+ >
54
+ > {
55
+ return new APIPromise($do(
56
+ client,
57
+ security,
58
+ request,
59
+ options,
60
+ ));
61
+ }
62
+
63
+ async function $do(
64
+ client: BotShieldCore,
65
+ security: operations.SDKVerifyResolutionSecurity,
66
+ request: operations.SDKVerifyResolutionRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.SDKVerifyResolutionResponse,
72
+ | errors.InvalidInputError
73
+ | errors.ErrorResponse
74
+ | BotShieldError
75
+ | ResponseValidationError
76
+ | ConnectionError
77
+ | RequestAbortedError
78
+ | RequestTimeoutError
79
+ | InvalidRequestError
80
+ | UnexpectedClientError
81
+ | SDKValidationError
82
+ >,
83
+ APICall,
84
+ ]
85
+ > {
86
+ const parsed = safeParse(
87
+ request,
88
+ (value) =>
89
+ operations.SDKVerifyResolutionRequest$outboundSchema.parse(value),
90
+ "Input validation failed",
91
+ );
92
+ if (!parsed.ok) {
93
+ return [parsed, { status: "invalid" }];
94
+ }
95
+ const payload = parsed.value;
96
+ const body = encodeJSON("body", payload, { explode: true });
97
+
98
+ const path = pathToFunc("/sdk/verify-resolution")();
99
+
100
+ const headers = new Headers(compactMap({
101
+ "Content-Type": "application/json",
102
+ Accept: "application/json",
103
+ }));
104
+
105
+ const requestSecurity = resolveSecurity(
106
+ [
107
+ {
108
+ fieldName: "Authorization",
109
+ type: "apiKey:header",
110
+ value: security?.agentKeyAuth,
111
+ },
112
+ ],
113
+ [
114
+ {
115
+ fieldName: "Authorization",
116
+ type: "apiKey:header",
117
+ value: security?.apiKeyAuth,
118
+ },
119
+ ],
120
+ );
121
+
122
+ const context = {
123
+ options: client._options,
124
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
125
+ operationID: "SdkVerifyResolution",
126
+ oAuth2Scopes: null,
127
+
128
+ resolvedSecurity: requestSecurity,
129
+
130
+ securitySource: security,
131
+ retryConfig: options?.retries
132
+ || client._options.retryConfig
133
+ || { strategy: "none" },
134
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
135
+ };
136
+
137
+ const requestRes = client._createRequest(context, {
138
+ security: requestSecurity,
139
+ method: "POST",
140
+ baseURL: options?.serverURL,
141
+ path: path,
142
+ headers: headers,
143
+ body: body,
144
+ userAgent: client._options.userAgent,
145
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
146
+ }, options);
147
+ if (!requestRes.ok) {
148
+ return [requestRes, { status: "invalid" }];
149
+ }
150
+ const req = requestRes.value;
151
+
152
+ const doResult = await client._do(req, {
153
+ context,
154
+ isErrorStatusCode: (statusCode: number) =>
155
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
156
+ retryConfig: context.retryConfig,
157
+ retryCodes: context.retryCodes,
158
+ });
159
+ if (!doResult.ok) {
160
+ return [doResult, { status: "request-error", request: req }];
161
+ }
162
+ const response = doResult.value;
163
+
164
+ const responseFields = {
165
+ HttpMeta: { Response: response, Request: req },
166
+ };
167
+
168
+ const [result] = await M.match<
169
+ operations.SDKVerifyResolutionResponse,
170
+ | errors.InvalidInputError
171
+ | errors.ErrorResponse
172
+ | BotShieldError
173
+ | ResponseValidationError
174
+ | ConnectionError
175
+ | RequestAbortedError
176
+ | RequestTimeoutError
177
+ | InvalidRequestError
178
+ | UnexpectedClientError
179
+ | SDKValidationError
180
+ >(
181
+ M.json(200, operations.SDKVerifyResolutionResponse$inboundSchema),
182
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
183
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
184
+ M.fail("4XX"),
185
+ M.fail("5XX"),
186
+ )(response, req, { extraFields: responseFields });
187
+ if (!result.ok) {
188
+ return [result, { status: "complete", request: req, response }];
189
+ }
190
+
191
+ return [result, { status: "complete", request: req, response }];
192
+ }
@@ -0,0 +1,171 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { BotShieldCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { resolveSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import { BotShieldError } from "../models/errors/bot-shield-error.js";
15
+ import {
16
+ ConnectionError,
17
+ InvalidRequestError,
18
+ RequestAbortedError,
19
+ RequestTimeoutError,
20
+ UnexpectedClientError,
21
+ } from "../models/errors/http-client-errors.js";
22
+ import { ResponseValidationError } from "../models/errors/response-validation-error.js";
23
+ import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
24
+ import * as operations from "../models/operations/index.js";
25
+ import { APICall, APIPromise } from "../types/async.js";
26
+ import { Result } from "../types/fp.js";
27
+
28
+ /**
29
+ * Confirm a pending link
30
+ *
31
+ * @remarks
32
+ * 4.0: on a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
33
+ */
34
+ export function censusConfirmLink(
35
+ client: BotShieldCore,
36
+ security: operations.SDKConfirmLinkSecurity,
37
+ request: operations.SDKConfirmLinkRequest,
38
+ options?: RequestOptions,
39
+ ): APIPromise<
40
+ Result<
41
+ operations.SDKConfirmLinkResponse,
42
+ | BotShieldError
43
+ | ResponseValidationError
44
+ | ConnectionError
45
+ | RequestAbortedError
46
+ | RequestTimeoutError
47
+ | InvalidRequestError
48
+ | UnexpectedClientError
49
+ | SDKValidationError
50
+ >
51
+ > {
52
+ return new APIPromise($do(
53
+ client,
54
+ security,
55
+ request,
56
+ options,
57
+ ));
58
+ }
59
+
60
+ async function $do(
61
+ client: BotShieldCore,
62
+ security: operations.SDKConfirmLinkSecurity,
63
+ request: operations.SDKConfirmLinkRequest,
64
+ options?: RequestOptions,
65
+ ): Promise<
66
+ [
67
+ Result<
68
+ operations.SDKConfirmLinkResponse,
69
+ | BotShieldError
70
+ | ResponseValidationError
71
+ | ConnectionError
72
+ | RequestAbortedError
73
+ | RequestTimeoutError
74
+ | InvalidRequestError
75
+ | UnexpectedClientError
76
+ | SDKValidationError
77
+ >,
78
+ APICall,
79
+ ]
80
+ > {
81
+ const parsed = safeParse(
82
+ request,
83
+ (value) => operations.SDKConfirmLinkRequest$outboundSchema.parse(value),
84
+ "Input validation failed",
85
+ );
86
+ if (!parsed.ok) {
87
+ return [parsed, { status: "invalid" }];
88
+ }
89
+ const payload = parsed.value;
90
+ const body = encodeJSON("body", payload, { explode: true });
91
+
92
+ const path = pathToFunc("/sdk/confirm-link")();
93
+
94
+ const headers = new Headers(compactMap({
95
+ "Content-Type": "application/json",
96
+ Accept: "application/json",
97
+ }));
98
+
99
+ const requestSecurity = resolveSecurity(
100
+ [
101
+ {
102
+ fieldName: "Authorization",
103
+ type: "apiKey:header",
104
+ value: security?.apiKeyAuth,
105
+ },
106
+ ],
107
+ );
108
+
109
+ const context = {
110
+ options: client._options,
111
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
112
+ operationID: "SdkConfirmLink",
113
+ oAuth2Scopes: null,
114
+
115
+ resolvedSecurity: requestSecurity,
116
+
117
+ securitySource: security,
118
+ retryConfig: options?.retries
119
+ || client._options.retryConfig
120
+ || { strategy: "none" },
121
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
122
+ };
123
+
124
+ const requestRes = client._createRequest(context, {
125
+ security: requestSecurity,
126
+ method: "POST",
127
+ baseURL: options?.serverURL,
128
+ path: path,
129
+ headers: headers,
130
+ body: body,
131
+ userAgent: client._options.userAgent,
132
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
133
+ }, options);
134
+ if (!requestRes.ok) {
135
+ return [requestRes, { status: "invalid" }];
136
+ }
137
+ const req = requestRes.value;
138
+
139
+ const doResult = await client._do(req, {
140
+ context,
141
+ isErrorStatusCode: (statusCode: number) =>
142
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
143
+ retryConfig: context.retryConfig,
144
+ retryCodes: context.retryCodes,
145
+ });
146
+ if (!doResult.ok) {
147
+ return [doResult, { status: "request-error", request: req }];
148
+ }
149
+ const response = doResult.value;
150
+
151
+ const [result] = await M.match<
152
+ operations.SDKConfirmLinkResponse,
153
+ | BotShieldError
154
+ | ResponseValidationError
155
+ | ConnectionError
156
+ | RequestAbortedError
157
+ | RequestTimeoutError
158
+ | InvalidRequestError
159
+ | UnexpectedClientError
160
+ | SDKValidationError
161
+ >(
162
+ M.json(200, operations.SDKConfirmLinkResponse$inboundSchema),
163
+ M.fail("4XX"),
164
+ M.fail("5XX"),
165
+ )(response, req);
166
+ if (!result.ok) {
167
+ return [result, { status: "complete", request: req, response }];
168
+ }
169
+
170
+ return [result, { status: "complete", request: req, response }];
171
+ }
@@ -31,6 +31,8 @@ import { Result } from "../types/fp.js";
31
31
  *
32
32
  * @remarks
33
33
  * Creates a verification request (deep link, web URL, QR code) for a gate. Requires an anchor grant token from create-session. Returns 409 when a pending request already exists for the same gate and user.
34
+ *
35
+ * **A check sent to one person** (a request with `partner_user_ref` whose account is linked, pushed to the person's phones): one is open at a time per organization, environment and person. A newer one that is pushed replaces the open one, which ends `cancelled` with reason `superseded` (verification/status) and fires `gate.unavailable` once with `failure_code: "superseded"`. Pushes are capped per person per day (default 5 in 24 hours); over the cap the request is still created and its QR / deep link work, but nothing is pushed (`push_skipped: "daily_cap"`).
34
36
  */
35
37
  export function censusCreateVerificationLink(
36
38
  client: BotShieldCore,