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
@@ -0,0 +1,184 @@
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
+ * Ask for a passkey sign-in
31
+ *
32
+ * @remarks
33
+ * 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).
34
+ */
35
+ export function signInRequest(
36
+ client: BotShieldCore,
37
+ security: operations.SigninRequestSecurity,
38
+ request: operations.SigninRequestRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.SigninRequestResponse,
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.SigninRequestSecurity,
66
+ request: operations.SigninRequestRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.SigninRequestResponse,
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) => operations.SigninRequestRequest$outboundSchema.parse(value),
89
+ "Input validation failed",
90
+ );
91
+ if (!parsed.ok) {
92
+ return [parsed, { status: "invalid" }];
93
+ }
94
+ const payload = parsed.value;
95
+ const body = encodeJSON("body", payload, { explode: true });
96
+
97
+ const path = pathToFunc("/signin/request")();
98
+
99
+ const headers = new Headers(compactMap({
100
+ "Content-Type": "application/json",
101
+ Accept: "application/json",
102
+ }));
103
+
104
+ const requestSecurity = resolveSecurity(
105
+ [
106
+ {
107
+ fieldName: "Authorization",
108
+ type: "apiKey:header",
109
+ value: security?.apiKeyAuth,
110
+ },
111
+ ],
112
+ );
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "SigninRequest",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: security,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "POST",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ body: body,
136
+ userAgent: client._options.userAgent,
137
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
138
+ }, options);
139
+ if (!requestRes.ok) {
140
+ return [requestRes, { status: "invalid" }];
141
+ }
142
+ const req = requestRes.value;
143
+
144
+ const doResult = await client._do(req, {
145
+ context,
146
+ isErrorStatusCode: (statusCode: number) =>
147
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.SigninRequestResponse,
162
+ | errors.InvalidInputError
163
+ | errors.ErrorResponse
164
+ | BotShieldError
165
+ | ResponseValidationError
166
+ | ConnectionError
167
+ | RequestAbortedError
168
+ | RequestTimeoutError
169
+ | InvalidRequestError
170
+ | UnexpectedClientError
171
+ | SDKValidationError
172
+ >(
173
+ M.json(200, operations.SigninRequestResponse$inboundSchema),
174
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
175
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
176
+ M.fail("4XX"),
177
+ M.fail("5XX"),
178
+ )(response, req, { extraFields: responseFields });
179
+ if (!result.ok) {
180
+ return [result, { status: "complete", request: req, response }];
181
+ }
182
+
183
+ return [result, { status: "complete", request: req, response }];
184
+ }
@@ -3,7 +3,7 @@
3
3
  */
4
4
 
5
5
  import { BotShieldCore } from "../core.js";
6
- import { encodeFormQuery } from "../lib/encodings.js";
6
+ import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
7
  import { matchStatusCode } from "../lib/http.js";
8
8
  import * as M from "../lib/matchers.js";
9
9
  import { compactMap } from "../lib/primitives.js";
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
30
30
  * Check verification status
31
31
  *
32
32
  * @remarks
33
- * 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.
33
+ * 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.
34
34
  */
35
35
  export function verificationGetStatus(
36
36
  client: BotShieldCore,
@@ -103,6 +103,11 @@ async function $do(
103
103
 
104
104
  const headers = new Headers(compactMap({
105
105
  Accept: "application/json",
106
+ "X-BotShield-Request-Secret": encodeSimple(
107
+ "X-BotShield-Request-Secret",
108
+ payload["X-BotShield-Request-Secret"],
109
+ { explode: false, charEncoding: "none" },
110
+ ),
106
111
  }));
107
112
 
108
113
  const requestSecurity = resolveSecurity(
package/src/lib/config.ts CHANGED
@@ -73,7 +73,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
73
73
  export const SDK_METADATA = {
74
74
  language: "typescript",
75
75
  openapiDocVersion: "2.0.0",
76
- sdkVersion: "2.3.0",
76
+ sdkVersion: "4.0.1",
77
77
  genVersion: "2.934.1",
78
- userAgent: "speakeasy-sdk/typescript 2.3.0 2.934.1 2.0.0 botshield-sdk",
78
+ userAgent: "speakeasy-sdk/typescript 4.0.1 2.934.1 2.0.0 botshield-sdk",
79
79
  } as const;
@@ -19,7 +19,7 @@ const routes = buildRouteMap({
19
19
  export const app = buildApplication(routes, {
20
20
  name: "mcp",
21
21
  versionInfo: {
22
- currentVersion: "2.3.0",
22
+ currentVersion: "4.0.1",
23
23
  },
24
24
  });
25
25
 
@@ -27,7 +27,7 @@ export function createMCPServer(deps: {
27
27
  }) {
28
28
  const server = new McpServer({
29
29
  name: "BotShield",
30
- version: "2.3.0",
30
+ version: "4.0.1",
31
31
  });
32
32
 
33
33
  const client = new BotShieldCore({
@@ -31,6 +31,19 @@ export type BotShieldActionEnvironment = OpenEnum<
31
31
  typeof BotShieldActionEnvironment
32
32
  >;
33
33
 
34
+ /**
35
+ * 4.0: `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
36
+ */
37
+ export const BotShieldActionKind = {
38
+ Action: "action",
39
+ Recovery: "recovery",
40
+ Signin: "signin",
41
+ } as const;
42
+ /**
43
+ * 4.0: `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
44
+ */
45
+ export type BotShieldActionKind = OpenEnum<typeof BotShieldActionKind>;
46
+
34
47
  /**
35
48
  * A BotShield Action: one act on your own surface keyed to a passkey. Not a gate — no schedule, no levers — and it always stands on a verified account, so a tap runs the linking ceremony.
36
49
  */
@@ -55,6 +68,30 @@ export type BotShieldAction = {
55
68
  environment: BotShieldActionEnvironment;
56
69
  placedAt: Date;
57
70
  turnedOffAt: Date | null;
71
+ /**
72
+ * Your support team can send this to a customer; its name is what the customer reads. Set with `staffCanSend` on create or update.
73
+ */
74
+ staffCanSend?: boolean | undefined;
75
+ /**
76
+ * 4.0: `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
77
+ */
78
+ kind?: BotShieldActionKind | undefined;
79
+ /**
80
+ * 4.0: on a Sign-on Action, whether BotShield's own QR may finish a sign-in (default off: your page's passkey only). Always false on other kinds.
81
+ */
82
+ signinQr?: boolean | undefined;
83
+ /**
84
+ * 4.0: a Recovery Action's new landing address while it waits to take effect (24 hours in Production; every admin is told). `where_url` is the address in effect until then.
85
+ */
86
+ pendingWhereUrl?: string | null | undefined;
87
+ /**
88
+ * 4.0: when `pending_where_url` takes effect.
89
+ */
90
+ pendingWhereUrlAt?: Date | null | undefined;
91
+ /**
92
+ * 4.0: high-value. It starts only from your customer's signed-in session (your server naming the account by your own reference); by phone number or by staff it is refused (`action_requires_signed_in`). Set with `highValue` on create or update.
93
+ */
94
+ highValue?: boolean | undefined;
58
95
  };
59
96
 
60
97
  /** @internal */
@@ -83,6 +120,19 @@ export const BotShieldActionEnvironment$outboundSchema: z.ZodType<
83
120
  BotShieldActionEnvironment
84
121
  > = openEnums.outboundSchema(BotShieldActionEnvironment);
85
122
 
123
+ /** @internal */
124
+ export const BotShieldActionKind$inboundSchema: z.ZodType<
125
+ BotShieldActionKind,
126
+ z.ZodTypeDef,
127
+ unknown
128
+ > = openEnums.inboundSchema(BotShieldActionKind);
129
+ /** @internal */
130
+ export const BotShieldActionKind$outboundSchema: z.ZodType<
131
+ string,
132
+ z.ZodTypeDef,
133
+ BotShieldActionKind
134
+ > = openEnums.outboundSchema(BotShieldActionKind);
135
+
86
136
  /** @internal */
87
137
  export const BotShieldAction$inboundSchema: z.ZodType<
88
138
  BotShieldAction,
@@ -97,12 +147,23 @@ export const BotShieldAction$inboundSchema: z.ZodType<
97
147
  environment: BotShieldActionEnvironment$inboundSchema,
98
148
  placed_at: types.date(),
99
149
  turned_off_at: types.nullable(types.date()),
150
+ staff_can_send: types.optional(types.boolean()),
151
+ kind: types.optional(BotShieldActionKind$inboundSchema),
152
+ signin_qr: types.optional(types.boolean()),
153
+ pending_where_url: z.nullable(types.string()).optional(),
154
+ pending_where_url_at: z.nullable(types.date()).optional(),
155
+ high_value: types.optional(types.boolean()),
100
156
  }).transform((v) => {
101
157
  return remap$(v, {
102
158
  "act_key": "actKey",
103
159
  "where_url": "whereUrl",
104
160
  "placed_at": "placedAt",
105
161
  "turned_off_at": "turnedOffAt",
162
+ "staff_can_send": "staffCanSend",
163
+ "signin_qr": "signinQr",
164
+ "pending_where_url": "pendingWhereUrl",
165
+ "pending_where_url_at": "pendingWhereUrlAt",
166
+ "high_value": "highValue",
106
167
  });
107
168
  });
108
169
  /** @internal */
@@ -115,6 +176,12 @@ export type BotShieldAction$Outbound = {
115
176
  environment: string;
116
177
  placed_at: string;
117
178
  turned_off_at: string | null;
179
+ staff_can_send?: boolean | undefined;
180
+ kind?: string | undefined;
181
+ signin_qr?: boolean | undefined;
182
+ pending_where_url?: string | null | undefined;
183
+ pending_where_url_at?: string | null | undefined;
184
+ high_value?: boolean | undefined;
118
185
  };
119
186
 
120
187
  /** @internal */
@@ -131,12 +198,24 @@ export const BotShieldAction$outboundSchema: z.ZodType<
131
198
  environment: BotShieldActionEnvironment$outboundSchema,
132
199
  placedAt: z.date().transform(v => v.toISOString()),
133
200
  turnedOffAt: z.nullable(z.date().transform(v => v.toISOString())),
201
+ staffCanSend: z.boolean().optional(),
202
+ kind: BotShieldActionKind$outboundSchema.optional(),
203
+ signinQr: z.boolean().optional(),
204
+ pendingWhereUrl: z.nullable(z.string()).optional(),
205
+ pendingWhereUrlAt: z.nullable(z.date().transform(v => v.toISOString()))
206
+ .optional(),
207
+ highValue: z.boolean().optional(),
134
208
  }).transform((v) => {
135
209
  return remap$(v, {
136
210
  actKey: "act_key",
137
211
  whereUrl: "where_url",
138
212
  placedAt: "placed_at",
139
213
  turnedOffAt: "turned_off_at",
214
+ staffCanSend: "staff_can_send",
215
+ signinQr: "signin_qr",
216
+ pendingWhereUrl: "pending_where_url",
217
+ pendingWhereUrlAt: "pending_where_url_at",
218
+ highValue: "high_value",
140
219
  });
141
220
  });
142
221
 
@@ -36,7 +36,7 @@ export type ErrorBody = {
36
36
  message: string;
37
37
  statusCode: number;
38
38
  /**
39
- * `ttl_below_floor`, `ttl_above_ceiling`, `trust_layer_rejected`, `trust_layer_unavailable`, `gate_required`, `alias_retired`, `RATE_LIMITED`, `inline_not_for_age_gate`.
39
+ * `ttl_below_floor`, `ttl_above_ceiling`, `trust_layer_rejected`, `trust_layer_unavailable`, `gate_required`, `alias_retired`, `RATE_LIMITED`, `inline_not_for_age_gate`, `act_label_has_link`, and in 4.0 `link_requires_server_session`, `account_override_refused`, `action_is_recovery`, `action_is_signin`, `invalid_key`, `recovery_code_invalid`, `handle_invalid`, `signin_not_set_up`, `not_verified`, `account_paused`, `signin_unknown`, `signin_pending`, `signin_refused`, `signin_expired`, `signin_used`, `signin_wrong_account`, `unavailable`.
40
40
  */
41
41
  code?: string | undefined;
42
42
  minTtlSeconds?: number | undefined;
@@ -53,6 +53,10 @@ export type ErrorBody = {
53
53
  * inline_not_for_age_gate only: the app hand-off for this request.
54
54
  */
55
55
  url?: string | undefined;
56
+ /**
57
+ * On a 429 limit (`too_many_open_requests`, `daily_request_limit`, `send_rate_limited`, `unanswered_limit_reached`): seconds until a retry can succeed.
58
+ */
59
+ retryAfterSeconds?: number | undefined;
56
60
  };
57
61
 
58
62
  /** @internal */
@@ -161,6 +165,7 @@ export const ErrorBody$inboundSchema: z.ZodType<
161
165
  limits: types.optional(z.lazy(() => Limits$inboundSchema)),
162
166
  upgrade_url: types.optional(types.string()),
163
167
  url: types.optional(types.string()),
168
+ retry_after_seconds: types.optional(types.number()),
164
169
  }).transform((v) => {
165
170
  return remap$(v, {
166
171
  "min_ttl_seconds": "minTtlSeconds",
@@ -168,6 +173,7 @@ export const ErrorBody$inboundSchema: z.ZodType<
168
173
  "next_step": "nextStep",
169
174
  "retry_in": "retryIn",
170
175
  "upgrade_url": "upgradeUrl",
176
+ "retry_after_seconds": "retryAfterSeconds",
171
177
  });
172
178
  });
173
179
  /** @internal */
@@ -186,6 +192,7 @@ export type ErrorBody$Outbound = {
186
192
  limits?: Limits$Outbound | undefined;
187
193
  upgrade_url?: string | undefined;
188
194
  url?: string | undefined;
195
+ retry_after_seconds?: number | undefined;
189
196
  };
190
197
 
191
198
  /** @internal */
@@ -208,6 +215,7 @@ export const ErrorBody$outboundSchema: z.ZodType<
208
215
  limits: z.lazy(() => Limits$outboundSchema).optional(),
209
216
  upgradeUrl: z.string().optional(),
210
217
  url: z.string().optional(),
218
+ retryAfterSeconds: z.number().int().optional(),
211
219
  }).transform((v) => {
212
220
  return remap$(v, {
213
221
  minTtlSeconds: "min_ttl_seconds",
@@ -215,6 +223,7 @@ export const ErrorBody$outboundSchema: z.ZodType<
215
223
  nextStep: "next_step",
216
224
  retryIn: "retry_in",
217
225
  upgradeUrl: "upgrade_url",
226
+ retryAfterSeconds: "retry_after_seconds",
218
227
  });
219
228
  });
220
229
 
@@ -0,0 +1,218 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../lib/primitives.js";
7
+ import { safeParse } from "../lib/schemas.js";
8
+ import { ClosedEnum } from "../types/enums.js";
9
+ import { Result as SafeParseResult } from "../types/fp.js";
10
+ import * as types from "../types/primitives.js";
11
+ import { SDKValidationError } from "./errors/sdk-validation-error.js";
12
+
13
+ export const GateUnavailableEventType = {
14
+ GateUnavailable: "gate.unavailable",
15
+ } as const;
16
+ export type GateUnavailableEventType = ClosedEnum<
17
+ typeof GateUnavailableEventType
18
+ >;
19
+
20
+ export const GateUnavailableEventVerdict = {
21
+ Unavailable: "unavailable",
22
+ } as const;
23
+ export type GateUnavailableEventVerdict = ClosedEnum<
24
+ typeof GateUnavailableEventVerdict
25
+ >;
26
+
27
+ /**
28
+ * The frozen reason. A policy refusal or a replaced check keeps `internal_error`; read `failure_code` for the cause.
29
+ */
30
+ export const GateUnavailableEventReason = {
31
+ UserDenied: "user_denied",
32
+ DeviceLockRequired: "device_lock_required",
33
+ InternalError: "internal_error",
34
+ PlatformDeclined: "platform_declined",
35
+ } as const;
36
+ /**
37
+ * The frozen reason. A policy refusal or a replaced check keeps `internal_error`; read `failure_code` for the cause.
38
+ */
39
+ export type GateUnavailableEventReason = ClosedEnum<
40
+ typeof GateUnavailableEventReason
41
+ >;
42
+
43
+ export const GateUnavailableEventEnvironment = {
44
+ Development: "development",
45
+ Production: "production",
46
+ } as const;
47
+ export type GateUnavailableEventEnvironment = ClosedEnum<
48
+ typeof GateUnavailableEventEnvironment
49
+ >;
50
+
51
+ /**
52
+ * Webhook `gate.unavailable` (delivered by Svix to your endpoint). Identity-free. Sent once per request when it ends without a pass: the person declined, the check failed or was refused, or a newer check replaced it. Not modeled as an OpenAPI `webhooks` entry, like `GateHumanVerifiedEvent`.
53
+ */
54
+ export type GateUnavailableEvent = {
55
+ type: GateUnavailableEventType;
56
+ /**
57
+ * Equals request_id.
58
+ */
59
+ eventId: string;
60
+ requestId: string;
61
+ failedAt: Date;
62
+ verdict: GateUnavailableEventVerdict;
63
+ /**
64
+ * The frozen reason. A policy refusal or a replaced check keeps `internal_error`; read `failure_code` for the cause.
65
+ */
66
+ reason: GateUnavailableEventReason;
67
+ errorMessage?: string | undefined;
68
+ /**
69
+ * The cause, when `reason` cannot name it. An open set: treat unknown values as unavailable. Includes `superseded` (a newer check you sent to the same person replaced this one), `already_trusted`, `rebind_requires_prior_id`, `pass_limit_reached`, `real_days_not_met`, `gate_not_open`, `signup_required`, `action_off`.
70
+ */
71
+ failureCode?: string | undefined;
72
+ /**
73
+ * The plain name for a refusal, beside the legacy `failure_code`, when there is one.
74
+ */
75
+ failureName?: string | undefined;
76
+ environment: GateUnavailableEventEnvironment;
77
+ /**
78
+ * Omitted when unknown.
79
+ */
80
+ product?: string | undefined;
81
+ /**
82
+ * BotShield Actions: the act this request was for, verbatim. Present only on an action request.
83
+ */
84
+ act?: string | undefined;
85
+ /**
86
+ * Your own metadata from create-session / create-verification-link, BotShield's internal keys removed. Omitted when empty.
87
+ */
88
+ metadata?: { [k: string]: any } | undefined;
89
+ };
90
+
91
+ /** @internal */
92
+ export const GateUnavailableEventType$inboundSchema: z.ZodNativeEnum<
93
+ typeof GateUnavailableEventType
94
+ > = z.nativeEnum(GateUnavailableEventType);
95
+ /** @internal */
96
+ export const GateUnavailableEventType$outboundSchema: z.ZodNativeEnum<
97
+ typeof GateUnavailableEventType
98
+ > = GateUnavailableEventType$inboundSchema;
99
+
100
+ /** @internal */
101
+ export const GateUnavailableEventVerdict$inboundSchema: z.ZodNativeEnum<
102
+ typeof GateUnavailableEventVerdict
103
+ > = z.nativeEnum(GateUnavailableEventVerdict);
104
+ /** @internal */
105
+ export const GateUnavailableEventVerdict$outboundSchema: z.ZodNativeEnum<
106
+ typeof GateUnavailableEventVerdict
107
+ > = GateUnavailableEventVerdict$inboundSchema;
108
+
109
+ /** @internal */
110
+ export const GateUnavailableEventReason$inboundSchema: z.ZodNativeEnum<
111
+ typeof GateUnavailableEventReason
112
+ > = z.nativeEnum(GateUnavailableEventReason);
113
+ /** @internal */
114
+ export const GateUnavailableEventReason$outboundSchema: z.ZodNativeEnum<
115
+ typeof GateUnavailableEventReason
116
+ > = GateUnavailableEventReason$inboundSchema;
117
+
118
+ /** @internal */
119
+ export const GateUnavailableEventEnvironment$inboundSchema: z.ZodNativeEnum<
120
+ typeof GateUnavailableEventEnvironment
121
+ > = z.nativeEnum(GateUnavailableEventEnvironment);
122
+ /** @internal */
123
+ export const GateUnavailableEventEnvironment$outboundSchema: z.ZodNativeEnum<
124
+ typeof GateUnavailableEventEnvironment
125
+ > = GateUnavailableEventEnvironment$inboundSchema;
126
+
127
+ /** @internal */
128
+ export const GateUnavailableEvent$inboundSchema: z.ZodType<
129
+ GateUnavailableEvent,
130
+ z.ZodTypeDef,
131
+ unknown
132
+ > = z.object({
133
+ type: GateUnavailableEventType$inboundSchema,
134
+ event_id: types.string(),
135
+ request_id: types.string(),
136
+ failed_at: types.date(),
137
+ verdict: GateUnavailableEventVerdict$inboundSchema,
138
+ reason: GateUnavailableEventReason$inboundSchema,
139
+ error_message: types.optional(types.string()),
140
+ failure_code: types.optional(types.string()),
141
+ failure_name: types.optional(types.string()),
142
+ environment: GateUnavailableEventEnvironment$inboundSchema,
143
+ product: types.optional(types.string()),
144
+ act: types.optional(types.string()),
145
+ metadata: types.optional(z.record(z.any())),
146
+ }).transform((v) => {
147
+ return remap$(v, {
148
+ "event_id": "eventId",
149
+ "request_id": "requestId",
150
+ "failed_at": "failedAt",
151
+ "error_message": "errorMessage",
152
+ "failure_code": "failureCode",
153
+ "failure_name": "failureName",
154
+ });
155
+ });
156
+ /** @internal */
157
+ export type GateUnavailableEvent$Outbound = {
158
+ type: string;
159
+ event_id: string;
160
+ request_id: string;
161
+ failed_at: string;
162
+ verdict: string;
163
+ reason: string;
164
+ error_message?: string | undefined;
165
+ failure_code?: string | undefined;
166
+ failure_name?: string | undefined;
167
+ environment: string;
168
+ product?: string | undefined;
169
+ act?: string | undefined;
170
+ metadata?: { [k: string]: any } | undefined;
171
+ };
172
+
173
+ /** @internal */
174
+ export const GateUnavailableEvent$outboundSchema: z.ZodType<
175
+ GateUnavailableEvent$Outbound,
176
+ z.ZodTypeDef,
177
+ GateUnavailableEvent
178
+ > = z.object({
179
+ type: GateUnavailableEventType$outboundSchema,
180
+ eventId: z.string(),
181
+ requestId: z.string(),
182
+ failedAt: z.date().transform(v => v.toISOString()),
183
+ verdict: GateUnavailableEventVerdict$outboundSchema,
184
+ reason: GateUnavailableEventReason$outboundSchema,
185
+ errorMessage: z.string().optional(),
186
+ failureCode: z.string().optional(),
187
+ failureName: z.string().optional(),
188
+ environment: GateUnavailableEventEnvironment$outboundSchema,
189
+ product: z.string().optional(),
190
+ act: z.string().optional(),
191
+ metadata: z.record(z.any()).optional(),
192
+ }).transform((v) => {
193
+ return remap$(v, {
194
+ eventId: "event_id",
195
+ requestId: "request_id",
196
+ failedAt: "failed_at",
197
+ errorMessage: "error_message",
198
+ failureCode: "failure_code",
199
+ failureName: "failure_name",
200
+ });
201
+ });
202
+
203
+ export function gateUnavailableEventToJSON(
204
+ gateUnavailableEvent: GateUnavailableEvent,
205
+ ): string {
206
+ return JSON.stringify(
207
+ GateUnavailableEvent$outboundSchema.parse(gateUnavailableEvent),
208
+ );
209
+ }
210
+ export function gateUnavailableEventFromJSON(
211
+ jsonString: string,
212
+ ): SafeParseResult<GateUnavailableEvent, SDKValidationError> {
213
+ return safeParse(
214
+ jsonString,
215
+ (x) => GateUnavailableEvent$inboundSchema.parse(JSON.parse(x)),
216
+ `Failed to parse 'GateUnavailableEvent' from JSON`,
217
+ );
218
+ }