botshield-sdk 2.2.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (408) hide show
  1. package/README.md +29 -9
  2. package/bin/mcp-server.js +1163 -122
  3. package/bin/mcp-server.js.map +37 -26
  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/inline-passkey-complete.d.ts +20 -0
  37. package/dist/commonjs/funcs/inline-passkey-complete.d.ts.map +1 -0
  38. package/dist/commonjs/funcs/inline-passkey-complete.js +116 -0
  39. package/dist/commonjs/funcs/inline-passkey-complete.js.map +1 -0
  40. package/dist/commonjs/funcs/inline-passkey-get-options.d.ts +20 -0
  41. package/dist/commonjs/funcs/inline-passkey-get-options.d.ts.map +1 -0
  42. package/dist/commonjs/funcs/inline-passkey-get-options.js +116 -0
  43. package/dist/commonjs/funcs/inline-passkey-get-options.js.map +1 -0
  44. package/dist/commonjs/funcs/verification-get-status.d.ts +1 -1
  45. package/dist/commonjs/funcs/verification-get-status.js +1 -1
  46. package/dist/commonjs/lib/config.d.ts +20 -4
  47. package/dist/commonjs/lib/config.d.ts.map +1 -1
  48. package/dist/commonjs/lib/config.js +22 -18
  49. package/dist/commonjs/lib/config.js.map +1 -1
  50. package/dist/commonjs/mcp-server/cli/start/command.d.ts.map +1 -1
  51. package/dist/commonjs/mcp-server/cli/start/command.js +4 -3
  52. package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
  53. package/dist/commonjs/mcp-server/cli/start/impl.d.ts +1 -1
  54. package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
  55. package/dist/commonjs/mcp-server/cli/start/impl.js +2 -2
  56. package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -1
  57. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  58. package/dist/commonjs/mcp-server/server.d.ts +1 -1
  59. package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
  60. package/dist/commonjs/mcp-server/server.js +2 -2
  61. package/dist/commonjs/mcp-server/server.js.map +1 -1
  62. package/dist/commonjs/models/bot-shield-action.d.ts +10 -0
  63. package/dist/commonjs/models/bot-shield-action.d.ts.map +1 -1
  64. package/dist/commonjs/models/bot-shield-action.js +8 -0
  65. package/dist/commonjs/models/bot-shield-action.js.map +1 -1
  66. package/dist/commonjs/models/error-body.d.ts +11 -1
  67. package/dist/commonjs/models/error-body.d.ts.map +1 -1
  68. package/dist/commonjs/models/error-body.js +6 -0
  69. package/dist/commonjs/models/error-body.js.map +1 -1
  70. package/dist/commonjs/models/gate-human-verified-event.d.ts +93 -0
  71. package/dist/commonjs/models/gate-human-verified-event.d.ts.map +1 -0
  72. package/dist/commonjs/models/gate-human-verified-event.js +119 -0
  73. package/dist/commonjs/models/gate-human-verified-event.js.map +1 -0
  74. package/dist/commonjs/models/gate-unavailable-event.d.ts +112 -0
  75. package/dist/commonjs/models/gate-unavailable-event.d.ts.map +1 -0
  76. package/dist/commonjs/models/gate-unavailable-event.js +137 -0
  77. package/dist/commonjs/models/gate-unavailable-event.js.map +1 -0
  78. package/dist/commonjs/models/gates-api-error.d.ts +5 -0
  79. package/dist/commonjs/models/gates-api-error.d.ts.map +1 -1
  80. package/dist/commonjs/models/gates-api-error.js +11 -0
  81. package/dist/commonjs/models/gates-api-error.js.map +1 -1
  82. package/dist/commonjs/models/index.d.ts +4 -0
  83. package/dist/commonjs/models/index.d.ts.map +1 -1
  84. package/dist/commonjs/models/index.js +4 -0
  85. package/dist/commonjs/models/index.js.map +1 -1
  86. package/dist/commonjs/models/inline-passkey-assertion.d.ts +66 -0
  87. package/dist/commonjs/models/inline-passkey-assertion.d.ts.map +1 -0
  88. package/dist/commonjs/models/inline-passkey-assertion.js +98 -0
  89. package/dist/commonjs/models/inline-passkey-assertion.js.map +1 -0
  90. package/dist/commonjs/models/inline-passkey-request-options.d.ts +78 -0
  91. package/dist/commonjs/models/inline-passkey-request-options.d.ts.map +1 -0
  92. package/dist/commonjs/models/inline-passkey-request-options.js +107 -0
  93. package/dist/commonjs/models/inline-passkey-request-options.js.map +1 -0
  94. package/dist/commonjs/models/operations/actions-propose.d.ts +21 -1
  95. package/dist/commonjs/models/operations/actions-propose.d.ts.map +1 -1
  96. package/dist/commonjs/models/operations/actions-propose.js +16 -0
  97. package/dist/commonjs/models/operations/actions-propose.js.map +1 -1
  98. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +11 -1
  99. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts.map +1 -1
  100. package/dist/commonjs/models/operations/gates-api-actions-create.js +4 -0
  101. package/dist/commonjs/models/operations/gates-api-actions-create.js.map +1 -1
  102. package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
  103. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  104. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  105. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js +178 -0
  106. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  107. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts +12 -1
  108. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  109. package/dist/commonjs/models/operations/gates-api-actions-request-status.js +2 -0
  110. package/dist/commonjs/models/operations/gates-api-actions-request-status.js.map +1 -1
  111. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +34 -4
  112. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts.map +1 -1
  113. package/dist/commonjs/models/operations/gates-api-actions-request.js +32 -3
  114. package/dist/commonjs/models/operations/gates-api-actions-request.js.map +1 -1
  115. package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
  116. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +99 -0
  117. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts.map +1 -0
  118. package/dist/commonjs/models/operations/gates-api-actions-update.js +141 -0
  119. package/dist/commonjs/models/operations/gates-api-actions-update.js.map +1 -0
  120. package/dist/commonjs/models/operations/index.d.ts +7 -0
  121. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  122. package/dist/commonjs/models/operations/index.js +7 -0
  123. package/dist/commonjs/models/operations/index.js.map +1 -1
  124. package/dist/commonjs/models/operations/request-passkey-complete.d.ts +107 -0
  125. package/dist/commonjs/models/operations/request-passkey-complete.d.ts.map +1 -0
  126. package/dist/commonjs/models/operations/request-passkey-complete.js +141 -0
  127. package/dist/commonjs/models/operations/request-passkey-complete.js.map +1 -0
  128. package/dist/commonjs/models/operations/request-passkey-options.d.ts +178 -0
  129. package/dist/commonjs/models/operations/request-passkey-options.d.ts.map +1 -0
  130. package/dist/commonjs/models/operations/request-passkey-options.js +193 -0
  131. package/dist/commonjs/models/operations/request-passkey-options.js.map +1 -0
  132. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts +130 -0
  133. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts.map +1 -0
  134. package/dist/commonjs/models/operations/sdk-confirm-link.js +205 -0
  135. package/dist/commonjs/models/operations/sdk-confirm-link.js.map +1 -0
  136. package/dist/commonjs/models/operations/sdk-create-session.d.ts +1 -1
  137. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +43 -2
  138. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  139. package/dist/commonjs/models/operations/sdk-create-verification-link.js +30 -1
  140. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  141. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +124 -0
  142. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts.map +1 -0
  143. package/dist/commonjs/models/operations/sdk-send-by-number.js +203 -0
  144. package/dist/commonjs/models/operations/sdk-send-by-number.js.map +1 -0
  145. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts +125 -0
  146. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  147. package/dist/commonjs/models/operations/sdk-verify-resolution.js +182 -0
  148. package/dist/commonjs/models/operations/sdk-verify-resolution.js.map +1 -0
  149. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +95 -1
  150. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  151. package/dist/commonjs/models/operations/sdk-verify-token.js +86 -1
  152. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  153. package/dist/commonjs/models/operations/verification-get-status.d.ts +86 -24
  154. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  155. package/dist/commonjs/models/operations/verification-get-status.js +70 -18
  156. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  157. package/dist/commonjs/models/passes-per-person.d.ts +1 -1
  158. package/dist/commonjs/sdk/actions.d.ts +8 -1
  159. package/dist/commonjs/sdk/actions.d.ts.map +1 -1
  160. package/dist/commonjs/sdk/actions.js +11 -1
  161. package/dist/commonjs/sdk/actions.js.map +1 -1
  162. package/dist/commonjs/sdk/census.d.ts +17 -1
  163. package/dist/commonjs/sdk/census.d.ts.map +1 -1
  164. package/dist/commonjs/sdk/census.js +23 -1
  165. package/dist/commonjs/sdk/census.js.map +1 -1
  166. package/dist/commonjs/sdk/gates-actions.d.ts +15 -1
  167. package/dist/commonjs/sdk/gates-actions.d.ts.map +1 -1
  168. package/dist/commonjs/sdk/gates-actions.js +21 -1
  169. package/dist/commonjs/sdk/gates-actions.js.map +1 -1
  170. package/dist/commonjs/sdk/inline-passkey.d.ts +23 -0
  171. package/dist/commonjs/sdk/inline-passkey.d.ts.map +1 -0
  172. package/dist/commonjs/sdk/inline-passkey.js +36 -0
  173. package/dist/commonjs/sdk/inline-passkey.js.map +1 -0
  174. package/dist/commonjs/sdk/sdk.d.ts +5 -2
  175. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  176. package/dist/commonjs/sdk/sdk.js +9 -4
  177. package/dist/commonjs/sdk/sdk.js.map +1 -1
  178. package/dist/commonjs/sdk/verification.d.ts +1 -1
  179. package/dist/commonjs/sdk/verification.js +1 -1
  180. package/dist/esm/funcs/actions-propose-action.d.ts +1 -1
  181. package/dist/esm/funcs/actions-propose-action.js +1 -1
  182. package/dist/esm/funcs/actions-verify-resolution.d.ts +18 -0
  183. package/dist/esm/funcs/actions-verify-resolution.d.ts.map +1 -0
  184. package/dist/esm/funcs/actions-verify-resolution.js +93 -0
  185. package/dist/esm/funcs/actions-verify-resolution.js.map +1 -0
  186. package/dist/esm/funcs/census-confirm-link.d.ts +17 -0
  187. package/dist/esm/funcs/census-confirm-link.d.ts.map +1 -0
  188. package/dist/esm/funcs/census-confirm-link.js +83 -0
  189. package/dist/esm/funcs/census-confirm-link.js.map +1 -0
  190. package/dist/esm/funcs/census-create-verification-link.d.ts +2 -0
  191. package/dist/esm/funcs/census-create-verification-link.d.ts.map +1 -1
  192. package/dist/esm/funcs/census-create-verification-link.js +2 -0
  193. package/dist/esm/funcs/census-create-verification-link.js.map +1 -1
  194. package/dist/esm/funcs/census-send-by-number.d.ts +18 -0
  195. package/dist/esm/funcs/census-send-by-number.d.ts.map +1 -0
  196. package/dist/esm/funcs/census-send-by-number.js +87 -0
  197. package/dist/esm/funcs/census-send-by-number.js.map +1 -0
  198. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  199. package/dist/esm/funcs/census-verify-token.js +1 -1
  200. package/dist/esm/funcs/gates-actions-request-cancel.d.ts +18 -0
  201. package/dist/esm/funcs/gates-actions-request-cancel.d.ts.map +1 -0
  202. package/dist/esm/funcs/gates-actions-request-cancel.js +87 -0
  203. package/dist/esm/funcs/gates-actions-request-cancel.js.map +1 -0
  204. package/dist/esm/funcs/gates-actions-request-status.js +1 -0
  205. package/dist/esm/funcs/gates-actions-request-status.js.map +1 -1
  206. package/dist/esm/funcs/gates-actions-request.d.ts +1 -1
  207. package/dist/esm/funcs/gates-actions-request.js +1 -1
  208. package/dist/esm/funcs/gates-actions-update.d.ts +18 -0
  209. package/dist/esm/funcs/gates-actions-update.d.ts.map +1 -0
  210. package/dist/esm/funcs/gates-actions-update.js +87 -0
  211. package/dist/esm/funcs/gates-actions-update.js.map +1 -0
  212. package/dist/esm/funcs/inline-passkey-complete.d.ts +20 -0
  213. package/dist/esm/funcs/inline-passkey-complete.d.ts.map +1 -0
  214. package/dist/esm/funcs/inline-passkey-complete.js +80 -0
  215. package/dist/esm/funcs/inline-passkey-complete.js.map +1 -0
  216. package/dist/esm/funcs/inline-passkey-get-options.d.ts +20 -0
  217. package/dist/esm/funcs/inline-passkey-get-options.d.ts.map +1 -0
  218. package/dist/esm/funcs/inline-passkey-get-options.js +80 -0
  219. package/dist/esm/funcs/inline-passkey-get-options.js.map +1 -0
  220. package/dist/esm/funcs/verification-get-status.d.ts +1 -1
  221. package/dist/esm/funcs/verification-get-status.js +1 -1
  222. package/dist/esm/lib/config.d.ts +20 -4
  223. package/dist/esm/lib/config.d.ts.map +1 -1
  224. package/dist/esm/lib/config.js +21 -17
  225. package/dist/esm/lib/config.js.map +1 -1
  226. package/dist/esm/mcp-server/cli/start/command.d.ts.map +1 -1
  227. package/dist/esm/mcp-server/cli/start/command.js +5 -4
  228. package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
  229. package/dist/esm/mcp-server/cli/start/impl.d.ts +1 -1
  230. package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
  231. package/dist/esm/mcp-server/cli/start/impl.js +2 -2
  232. package/dist/esm/mcp-server/cli/start/impl.js.map +1 -1
  233. package/dist/esm/mcp-server/mcp-server.js +1 -1
  234. package/dist/esm/mcp-server/server.d.ts +1 -1
  235. package/dist/esm/mcp-server/server.d.ts.map +1 -1
  236. package/dist/esm/mcp-server/server.js +2 -2
  237. package/dist/esm/mcp-server/server.js.map +1 -1
  238. package/dist/esm/models/bot-shield-action.d.ts +10 -0
  239. package/dist/esm/models/bot-shield-action.d.ts.map +1 -1
  240. package/dist/esm/models/bot-shield-action.js +8 -0
  241. package/dist/esm/models/bot-shield-action.js.map +1 -1
  242. package/dist/esm/models/error-body.d.ts +11 -1
  243. package/dist/esm/models/error-body.d.ts.map +1 -1
  244. package/dist/esm/models/error-body.js +6 -0
  245. package/dist/esm/models/error-body.js.map +1 -1
  246. package/dist/esm/models/gate-human-verified-event.d.ts +93 -0
  247. package/dist/esm/models/gate-human-verified-event.d.ts.map +1 -0
  248. package/dist/esm/models/gate-human-verified-event.js +81 -0
  249. package/dist/esm/models/gate-human-verified-event.js.map +1 -0
  250. package/dist/esm/models/gate-unavailable-event.d.ts +112 -0
  251. package/dist/esm/models/gate-unavailable-event.d.ts.map +1 -0
  252. package/dist/esm/models/gate-unavailable-event.js +99 -0
  253. package/dist/esm/models/gate-unavailable-event.js.map +1 -0
  254. package/dist/esm/models/gates-api-error.d.ts +5 -0
  255. package/dist/esm/models/gates-api-error.d.ts.map +1 -1
  256. package/dist/esm/models/gates-api-error.js +11 -0
  257. package/dist/esm/models/gates-api-error.js.map +1 -1
  258. package/dist/esm/models/index.d.ts +4 -0
  259. package/dist/esm/models/index.d.ts.map +1 -1
  260. package/dist/esm/models/index.js +4 -0
  261. package/dist/esm/models/index.js.map +1 -1
  262. package/dist/esm/models/inline-passkey-assertion.d.ts +66 -0
  263. package/dist/esm/models/inline-passkey-assertion.d.ts.map +1 -0
  264. package/dist/esm/models/inline-passkey-assertion.js +58 -0
  265. package/dist/esm/models/inline-passkey-assertion.js.map +1 -0
  266. package/dist/esm/models/inline-passkey-request-options.d.ts +78 -0
  267. package/dist/esm/models/inline-passkey-request-options.d.ts.map +1 -0
  268. package/dist/esm/models/inline-passkey-request-options.js +67 -0
  269. package/dist/esm/models/inline-passkey-request-options.js.map +1 -0
  270. package/dist/esm/models/operations/actions-propose.d.ts +21 -1
  271. package/dist/esm/models/operations/actions-propose.d.ts.map +1 -1
  272. package/dist/esm/models/operations/actions-propose.js +16 -0
  273. package/dist/esm/models/operations/actions-propose.js.map +1 -1
  274. package/dist/esm/models/operations/gates-api-actions-create.d.ts +11 -1
  275. package/dist/esm/models/operations/gates-api-actions-create.d.ts.map +1 -1
  276. package/dist/esm/models/operations/gates-api-actions-create.js +4 -0
  277. package/dist/esm/models/operations/gates-api-actions-create.js.map +1 -1
  278. package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
  279. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  280. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  281. package/dist/esm/models/operations/gates-api-actions-request-cancel.js +132 -0
  282. package/dist/esm/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  283. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts +12 -1
  284. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  285. package/dist/esm/models/operations/gates-api-actions-request-status.js +2 -0
  286. package/dist/esm/models/operations/gates-api-actions-request-status.js.map +1 -1
  287. package/dist/esm/models/operations/gates-api-actions-request.d.ts +34 -4
  288. package/dist/esm/models/operations/gates-api-actions-request.d.ts.map +1 -1
  289. package/dist/esm/models/operations/gates-api-actions-request.js +29 -2
  290. package/dist/esm/models/operations/gates-api-actions-request.js.map +1 -1
  291. package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
  292. package/dist/esm/models/operations/gates-api-actions-update.d.ts +99 -0
  293. package/dist/esm/models/operations/gates-api-actions-update.d.ts.map +1 -0
  294. package/dist/esm/models/operations/gates-api-actions-update.js +95 -0
  295. package/dist/esm/models/operations/gates-api-actions-update.js.map +1 -0
  296. package/dist/esm/models/operations/index.d.ts +7 -0
  297. package/dist/esm/models/operations/index.d.ts.map +1 -1
  298. package/dist/esm/models/operations/index.js +7 -0
  299. package/dist/esm/models/operations/index.js.map +1 -1
  300. package/dist/esm/models/operations/request-passkey-complete.d.ts +107 -0
  301. package/dist/esm/models/operations/request-passkey-complete.d.ts.map +1 -0
  302. package/dist/esm/models/operations/request-passkey-complete.js +97 -0
  303. package/dist/esm/models/operations/request-passkey-complete.js.map +1 -0
  304. package/dist/esm/models/operations/request-passkey-options.d.ts +178 -0
  305. package/dist/esm/models/operations/request-passkey-options.d.ts.map +1 -0
  306. package/dist/esm/models/operations/request-passkey-options.js +149 -0
  307. package/dist/esm/models/operations/request-passkey-options.js.map +1 -0
  308. package/dist/esm/models/operations/sdk-confirm-link.d.ts +130 -0
  309. package/dist/esm/models/operations/sdk-confirm-link.d.ts.map +1 -0
  310. package/dist/esm/models/operations/sdk-confirm-link.js +157 -0
  311. package/dist/esm/models/operations/sdk-confirm-link.js.map +1 -0
  312. package/dist/esm/models/operations/sdk-create-session.d.ts +1 -1
  313. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +43 -2
  314. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  315. package/dist/esm/models/operations/sdk-create-verification-link.js +29 -0
  316. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  317. package/dist/esm/models/operations/sdk-send-by-number.d.ts +124 -0
  318. package/dist/esm/models/operations/sdk-send-by-number.d.ts.map +1 -0
  319. package/dist/esm/models/operations/sdk-send-by-number.js +155 -0
  320. package/dist/esm/models/operations/sdk-send-by-number.js.map +1 -0
  321. package/dist/esm/models/operations/sdk-verify-resolution.d.ts +125 -0
  322. package/dist/esm/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  323. package/dist/esm/models/operations/sdk-verify-resolution.js +136 -0
  324. package/dist/esm/models/operations/sdk-verify-resolution.js.map +1 -0
  325. package/dist/esm/models/operations/sdk-verify-token.d.ts +95 -1
  326. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  327. package/dist/esm/models/operations/sdk-verify-token.js +83 -0
  328. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  329. package/dist/esm/models/operations/verification-get-status.d.ts +86 -24
  330. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  331. package/dist/esm/models/operations/verification-get-status.js +69 -17
  332. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  333. package/dist/esm/models/passes-per-person.d.ts +1 -1
  334. package/dist/esm/sdk/actions.d.ts +8 -1
  335. package/dist/esm/sdk/actions.d.ts.map +1 -1
  336. package/dist/esm/sdk/actions.js +11 -1
  337. package/dist/esm/sdk/actions.js.map +1 -1
  338. package/dist/esm/sdk/census.d.ts +17 -1
  339. package/dist/esm/sdk/census.d.ts.map +1 -1
  340. package/dist/esm/sdk/census.js +23 -1
  341. package/dist/esm/sdk/census.js.map +1 -1
  342. package/dist/esm/sdk/gates-actions.d.ts +15 -1
  343. package/dist/esm/sdk/gates-actions.d.ts.map +1 -1
  344. package/dist/esm/sdk/gates-actions.js +21 -1
  345. package/dist/esm/sdk/gates-actions.js.map +1 -1
  346. package/dist/esm/sdk/inline-passkey.d.ts +23 -0
  347. package/dist/esm/sdk/inline-passkey.d.ts.map +1 -0
  348. package/dist/esm/sdk/inline-passkey.js +32 -0
  349. package/dist/esm/sdk/inline-passkey.js.map +1 -0
  350. package/dist/esm/sdk/sdk.d.ts +5 -2
  351. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  352. package/dist/esm/sdk/sdk.js +9 -4
  353. package/dist/esm/sdk/sdk.js.map +1 -1
  354. package/dist/esm/sdk/verification.d.ts +1 -1
  355. package/dist/esm/sdk/verification.js +1 -1
  356. package/jsr.json +1 -1
  357. package/package.json +1 -1
  358. package/src/funcs/actions-propose-action.ts +1 -1
  359. package/src/funcs/actions-verify-resolution.ts +192 -0
  360. package/src/funcs/census-confirm-link.ts +171 -0
  361. package/src/funcs/census-create-verification-link.ts +2 -0
  362. package/src/funcs/census-send-by-number.ts +180 -0
  363. package/src/funcs/census-verify-token.ts +1 -1
  364. package/src/funcs/gates-actions-request-cancel.ts +187 -0
  365. package/src/funcs/gates-actions-request-status.ts +1 -0
  366. package/src/funcs/gates-actions-request.ts +1 -1
  367. package/src/funcs/gates-actions-update.ts +185 -0
  368. package/src/funcs/inline-passkey-complete.ts +172 -0
  369. package/src/funcs/inline-passkey-get-options.ts +172 -0
  370. package/src/funcs/verification-get-status.ts +1 -1
  371. package/src/lib/config.ts +22 -18
  372. package/src/mcp-server/cli/start/command.ts +5 -4
  373. package/src/mcp-server/cli/start/impl.ts +3 -3
  374. package/src/mcp-server/mcp-server.ts +1 -1
  375. package/src/mcp-server/server.ts +3 -3
  376. package/src/models/bot-shield-action.ts +18 -0
  377. package/src/models/error-body.ts +17 -1
  378. package/src/models/gate-human-verified-event.ts +181 -0
  379. package/src/models/gate-unavailable-event.ts +218 -0
  380. package/src/models/gates-api-error.ts +16 -0
  381. package/src/models/index.ts +4 -0
  382. package/src/models/inline-passkey-assertion.ts +147 -0
  383. package/src/models/inline-passkey-request-options.ts +175 -0
  384. package/src/models/operations/actions-propose.ts +37 -1
  385. package/src/models/operations/gates-api-actions-create.ts +15 -1
  386. package/src/models/operations/gates-api-actions-list.ts +1 -1
  387. package/src/models/operations/gates-api-actions-request-cancel.ts +339 -0
  388. package/src/models/operations/gates-api-actions-request-status.ts +14 -1
  389. package/src/models/operations/gates-api-actions-request.ts +83 -6
  390. package/src/models/operations/gates-api-actions-set-state.ts +1 -1
  391. package/src/models/operations/gates-api-actions-update.ts +281 -0
  392. package/src/models/operations/index.ts +7 -0
  393. package/src/models/operations/request-passkey-complete.ts +272 -0
  394. package/src/models/operations/request-passkey-options.ts +372 -0
  395. package/src/models/operations/sdk-confirm-link.ts +380 -0
  396. package/src/models/operations/sdk-create-session.ts +1 -1
  397. package/src/models/operations/sdk-create-verification-link.ts +69 -2
  398. package/src/models/operations/sdk-send-by-number.ts +372 -0
  399. package/src/models/operations/sdk-verify-resolution.ts +341 -0
  400. package/src/models/operations/sdk-verify-token.ts +189 -1
  401. package/src/models/operations/verification-get-status.ts +151 -38
  402. package/src/models/passes-per-person.ts +1 -1
  403. package/src/sdk/actions.ts +21 -1
  404. package/src/sdk/census.ts +43 -1
  405. package/src/sdk/gates-actions.ts +41 -1
  406. package/src/sdk/inline-passkey.ts +49 -0
  407. package/src/sdk/sdk.ts +11 -5
  408. package/src/sdk/verification.ts +1 -1
@@ -26,6 +26,10 @@ export type SDKVerifyTokenRequest = {
26
26
  * Your organization id (the organization_id shown in Console settings). When given, a token issued for any other organization is rejected.
27
27
  */
28
28
  audience?: string | undefined;
29
+ /**
30
+ * 4.0: with your secret key, on a token whose link is pending, this confirms the link (same as sdk/confirm-link). The answer's `link` says whether it went live.
31
+ */
32
+ partnerUserRef?: string | undefined;
29
33
  };
30
34
 
31
35
  /**
@@ -41,6 +45,32 @@ export const AgeOver = {
41
45
  */
42
46
  export type AgeOver = OpenEnum<typeof AgeOver>;
43
47
 
48
+ /**
49
+ * `verification`: a person passed a check or a link. `action`: a person confirmed a BotShield Action. Null on a token issued before 4.0.
50
+ */
51
+ export const Kind = {
52
+ Verification: "verification",
53
+ Action: "action",
54
+ } as const;
55
+ /**
56
+ * `verification`: a person passed a check or a link. `action`: a person confirmed a BotShield Action. Null on a token issued before 4.0.
57
+ */
58
+ export type Kind = OpenEnum<typeof Kind>;
59
+
60
+ /**
61
+ * The environment of the key that started the request. Null on a token issued before 4.0, or when it was not known.
62
+ */
63
+ export const SDKVerifyTokenEnvironment = {
64
+ Development: "development",
65
+ Production: "production",
66
+ } as const;
67
+ /**
68
+ * The environment of the key that started the request. Null on a token issued before 4.0, or when it was not known.
69
+ */
70
+ export type SDKVerifyTokenEnvironment = OpenEnum<
71
+ typeof SDKVerifyTokenEnvironment
72
+ >;
73
+
44
74
  export type Claims = {
45
75
  requestId?: string | undefined;
46
76
  verified?: boolean | undefined;
@@ -73,6 +103,18 @@ export type Claims = {
73
103
  * BotShield Actions: the `act` this tap was for, echoed verbatim (your own string, e.g. `dibs:listing_4417`). Present only on tokens minted for an action.
74
104
  */
75
105
  act?: string | undefined;
106
+ /**
107
+ * `verification`: a person passed a check or a link. `action`: a person confirmed a BotShield Action. Null on a token issued before 4.0.
108
+ */
109
+ kind?: Kind | null | undefined;
110
+ /**
111
+ * The environment of the key that started the request. Null on a token issued before 4.0, or when it was not known.
112
+ */
113
+ environment?: SDKVerifyTokenEnvironment | null | undefined;
114
+ /**
115
+ * 4.0: where the link stood for this token: `pending`, `live`, `expired` or `refused`. Absent on a plain check.
116
+ */
117
+ linkState?: string | undefined;
76
118
  };
77
119
 
78
120
  /**
@@ -87,10 +129,32 @@ export const SDKVerifyTokenVerdict = {
87
129
  */
88
130
  export type SDKVerifyTokenVerdict = OpenEnum<typeof SDKVerifyTokenVerdict>;
89
131
 
132
+ export const SDKVerifyTokenState = {
133
+ Pending: "pending",
134
+ Live: "live",
135
+ NotLive: "not_live",
136
+ } as const;
137
+ export type SDKVerifyTokenState = OpenEnum<typeof SDKVerifyTokenState>;
138
+
139
+ /**
140
+ * 4.0: present only on a token whose link waited for your server. `pending`: not confirmed (send your secret key and `partner_user_ref`, or call sdk/confirm-link). `live` with `confirmed: true`: this check confirmed it. `not_live`: the confirm was refused (`code`).
141
+ */
142
+ export type SDKVerifyTokenLink = {
143
+ state?: SDKVerifyTokenState | undefined;
144
+ confirmed?: boolean | undefined;
145
+ handle?: string | undefined;
146
+ firstTime?: boolean | undefined;
147
+ /**
148
+ * `link_pending`, or the confirm refusal code (as sdk/confirm-link).
149
+ */
150
+ code?: string | undefined;
151
+ message?: string | undefined;
152
+ };
153
+
90
154
  export type SDKVerifyTokenDataData = {
91
155
  valid: boolean;
92
156
  /**
93
- * Present when valid is false.
157
+ * Present when valid is false. A plain line, not a code. Includes: `Invalid token — not a BotShield verification token` (a token of another kind), `Invalid token — unknown environment`, and `Token was issued in the development environment; this key is production.` (or the reverse).
94
158
  */
95
159
  reason?: string | undefined;
96
160
  /**
@@ -106,6 +170,10 @@ export type SDKVerifyTokenDataData = {
106
170
  * Present when `valid` is true. `pass` when the token records a verified human.
107
171
  */
108
172
  verdict?: SDKVerifyTokenVerdict | undefined;
173
+ /**
174
+ * 4.0: present only on a token whose link waited for your server. `pending`: not confirmed (send your secret key and `partner_user_ref`, or call sdk/confirm-link). `live` with `confirmed: true`: this check confirmed it. `not_live`: the confirm was refused (`code`).
175
+ */
176
+ link?: SDKVerifyTokenLink | undefined;
109
177
  };
110
178
 
111
179
  export type SDKVerifyTokenData = {
@@ -173,11 +241,17 @@ export const SDKVerifyTokenRequest$inboundSchema: z.ZodType<
173
241
  > = z.object({
174
242
  token: types.string(),
175
243
  audience: types.optional(types.string()),
244
+ partner_user_ref: types.optional(types.string()),
245
+ }).transform((v) => {
246
+ return remap$(v, {
247
+ "partner_user_ref": "partnerUserRef",
248
+ });
176
249
  });
177
250
  /** @internal */
178
251
  export type SDKVerifyTokenRequest$Outbound = {
179
252
  token: string;
180
253
  audience?: string | undefined;
254
+ partner_user_ref?: string | undefined;
181
255
  };
182
256
 
183
257
  /** @internal */
@@ -188,6 +262,11 @@ export const SDKVerifyTokenRequest$outboundSchema: z.ZodType<
188
262
  > = z.object({
189
263
  token: z.string(),
190
264
  audience: z.string().optional(),
265
+ partnerUserRef: z.string().optional(),
266
+ }).transform((v) => {
267
+ return remap$(v, {
268
+ partnerUserRef: "partner_user_ref",
269
+ });
191
270
  });
192
271
 
193
272
  export function sdkVerifyTokenRequestToJSON(
@@ -214,6 +293,26 @@ export const AgeOver$inboundSchema: z.ZodType<AgeOver, z.ZodTypeDef, unknown> =
214
293
  export const AgeOver$outboundSchema: z.ZodType<number, z.ZodTypeDef, AgeOver> =
215
294
  openEnums.outboundSchemaInt(AgeOver);
216
295
 
296
+ /** @internal */
297
+ export const Kind$inboundSchema: z.ZodType<Kind, z.ZodTypeDef, unknown> =
298
+ openEnums.inboundSchema(Kind);
299
+ /** @internal */
300
+ export const Kind$outboundSchema: z.ZodType<string, z.ZodTypeDef, Kind> =
301
+ openEnums.outboundSchema(Kind);
302
+
303
+ /** @internal */
304
+ export const SDKVerifyTokenEnvironment$inboundSchema: z.ZodType<
305
+ SDKVerifyTokenEnvironment,
306
+ z.ZodTypeDef,
307
+ unknown
308
+ > = openEnums.inboundSchema(SDKVerifyTokenEnvironment);
309
+ /** @internal */
310
+ export const SDKVerifyTokenEnvironment$outboundSchema: z.ZodType<
311
+ string,
312
+ z.ZodTypeDef,
313
+ SDKVerifyTokenEnvironment
314
+ > = openEnums.outboundSchema(SDKVerifyTokenEnvironment);
315
+
217
316
  /** @internal */
218
317
  export const Claims$inboundSchema: z.ZodType<Claims, z.ZodTypeDef, unknown> = z
219
318
  .object({
@@ -230,6 +329,9 @@ export const Claims$inboundSchema: z.ZodType<Claims, z.ZodTypeDef, unknown> = z
230
329
  last_pass_at: types.optional(types.date()),
231
330
  audience: z.nullable(types.string()).optional(),
232
331
  act: types.optional(types.string()),
332
+ kind: z.nullable(Kind$inboundSchema).optional(),
333
+ environment: z.nullable(SDKVerifyTokenEnvironment$inboundSchema).optional(),
334
+ link_state: types.optional(types.string()),
233
335
  }).transform((v) => {
234
336
  return remap$(v, {
235
337
  "request_id": "requestId",
@@ -239,6 +341,7 @@ export const Claims$inboundSchema: z.ZodType<Claims, z.ZodTypeDef, unknown> = z
239
341
  "age_over": "ageOver",
240
342
  "trusted_since": "trustedSince",
241
343
  "last_pass_at": "lastPassAt",
344
+ "link_state": "linkState",
242
345
  });
243
346
  });
244
347
  /** @internal */
@@ -256,6 +359,9 @@ export type Claims$Outbound = {
256
359
  last_pass_at?: string | undefined;
257
360
  audience?: string | null | undefined;
258
361
  act?: string | undefined;
362
+ kind?: string | null | undefined;
363
+ environment?: string | null | undefined;
364
+ link_state?: string | undefined;
259
365
  };
260
366
 
261
367
  /** @internal */
@@ -277,6 +383,9 @@ export const Claims$outboundSchema: z.ZodType<
277
383
  lastPassAt: z.date().transform(v => v.toISOString()).optional(),
278
384
  audience: z.nullable(z.string()).optional(),
279
385
  act: z.string().optional(),
386
+ kind: z.nullable(Kind$outboundSchema).optional(),
387
+ environment: z.nullable(SDKVerifyTokenEnvironment$outboundSchema).optional(),
388
+ linkState: z.string().optional(),
280
389
  }).transform((v) => {
281
390
  return remap$(v, {
282
391
  requestId: "request_id",
@@ -286,6 +395,7 @@ export const Claims$outboundSchema: z.ZodType<
286
395
  ageOver: "age_over",
287
396
  trustedSince: "trusted_since",
288
397
  lastPassAt: "last_pass_at",
398
+ linkState: "link_state",
289
399
  });
290
400
  });
291
401
 
@@ -315,6 +425,81 @@ export const SDKVerifyTokenVerdict$outboundSchema: z.ZodType<
315
425
  SDKVerifyTokenVerdict
316
426
  > = openEnums.outboundSchema(SDKVerifyTokenVerdict);
317
427
 
428
+ /** @internal */
429
+ export const SDKVerifyTokenState$inboundSchema: z.ZodType<
430
+ SDKVerifyTokenState,
431
+ z.ZodTypeDef,
432
+ unknown
433
+ > = openEnums.inboundSchema(SDKVerifyTokenState);
434
+ /** @internal */
435
+ export const SDKVerifyTokenState$outboundSchema: z.ZodType<
436
+ string,
437
+ z.ZodTypeDef,
438
+ SDKVerifyTokenState
439
+ > = openEnums.outboundSchema(SDKVerifyTokenState);
440
+
441
+ /** @internal */
442
+ export const SDKVerifyTokenLink$inboundSchema: z.ZodType<
443
+ SDKVerifyTokenLink,
444
+ z.ZodTypeDef,
445
+ unknown
446
+ > = z.object({
447
+ state: types.optional(SDKVerifyTokenState$inboundSchema),
448
+ confirmed: types.optional(types.boolean()),
449
+ handle: types.optional(types.string()),
450
+ first_time: types.optional(types.boolean()),
451
+ code: types.optional(types.string()),
452
+ message: types.optional(types.string()),
453
+ }).transform((v) => {
454
+ return remap$(v, {
455
+ "first_time": "firstTime",
456
+ });
457
+ });
458
+ /** @internal */
459
+ export type SDKVerifyTokenLink$Outbound = {
460
+ state?: string | undefined;
461
+ confirmed?: boolean | undefined;
462
+ handle?: string | undefined;
463
+ first_time?: boolean | undefined;
464
+ code?: string | undefined;
465
+ message?: string | undefined;
466
+ };
467
+
468
+ /** @internal */
469
+ export const SDKVerifyTokenLink$outboundSchema: z.ZodType<
470
+ SDKVerifyTokenLink$Outbound,
471
+ z.ZodTypeDef,
472
+ SDKVerifyTokenLink
473
+ > = z.object({
474
+ state: SDKVerifyTokenState$outboundSchema.optional(),
475
+ confirmed: z.boolean().optional(),
476
+ handle: z.string().optional(),
477
+ firstTime: z.boolean().optional(),
478
+ code: z.string().optional(),
479
+ message: z.string().optional(),
480
+ }).transform((v) => {
481
+ return remap$(v, {
482
+ firstTime: "first_time",
483
+ });
484
+ });
485
+
486
+ export function sdkVerifyTokenLinkToJSON(
487
+ sdkVerifyTokenLink: SDKVerifyTokenLink,
488
+ ): string {
489
+ return JSON.stringify(
490
+ SDKVerifyTokenLink$outboundSchema.parse(sdkVerifyTokenLink),
491
+ );
492
+ }
493
+ export function sdkVerifyTokenLinkFromJSON(
494
+ jsonString: string,
495
+ ): SafeParseResult<SDKVerifyTokenLink, SDKValidationError> {
496
+ return safeParse(
497
+ jsonString,
498
+ (x) => SDKVerifyTokenLink$inboundSchema.parse(JSON.parse(x)),
499
+ `Failed to parse 'SDKVerifyTokenLink' from JSON`,
500
+ );
501
+ }
502
+
318
503
  /** @internal */
319
504
  export const SDKVerifyTokenDataData$inboundSchema: z.ZodType<
320
505
  SDKVerifyTokenDataData,
@@ -327,6 +512,7 @@ export const SDKVerifyTokenDataData$inboundSchema: z.ZodType<
327
512
  claims: z.nullable(z.lazy(() => Claims$inboundSchema)).optional(),
328
513
  replayed: types.optional(types.boolean()),
329
514
  verdict: types.optional(SDKVerifyTokenVerdict$inboundSchema),
515
+ link: types.optional(z.lazy(() => SDKVerifyTokenLink$inboundSchema)),
330
516
  }).transform((v) => {
331
517
  return remap$(v, {
332
518
  "expired_at": "expiredAt",
@@ -340,6 +526,7 @@ export type SDKVerifyTokenDataData$Outbound = {
340
526
  claims?: Claims$Outbound | null | undefined;
341
527
  replayed?: boolean | undefined;
342
528
  verdict?: string | undefined;
529
+ link?: SDKVerifyTokenLink$Outbound | undefined;
343
530
  };
344
531
 
345
532
  /** @internal */
@@ -354,6 +541,7 @@ export const SDKVerifyTokenDataData$outboundSchema: z.ZodType<
354
541
  claims: z.nullable(z.lazy(() => Claims$outboundSchema)).optional(),
355
542
  replayed: z.boolean().optional(),
356
543
  verdict: SDKVerifyTokenVerdict$outboundSchema.optional(),
544
+ link: z.lazy(() => SDKVerifyTokenLink$outboundSchema).optional(),
357
545
  }).transform((v) => {
358
546
  return remap$(v, {
359
547
  expiredAt: "expired_at",
@@ -22,7 +22,7 @@ export type VerificationGetStatusRequest = {
22
22
  };
23
23
 
24
24
  /**
25
- * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`.
25
+ * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`. `cancelled`: the request ended without an answer; see `reason` (`declined`: the person cancelled the link ask; `superseded`: a newer check sent to the same person replaced this one).
26
26
  */
27
27
  export const VerificationGetStatusStatus = {
28
28
  Pending: "pending",
@@ -30,11 +30,12 @@ export const VerificationGetStatusStatus = {
30
30
  Pass: "pass",
31
31
  Expired: "expired",
32
32
  Failed: "failed",
33
+ Cancelled: "cancelled",
33
34
  NotFound: "not_found",
34
35
  Error: "error",
35
36
  } as const;
36
37
  /**
37
- * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`.
38
+ * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`. `cancelled`: the request ended without an answer; see `reason` (`declined`: the person cancelled the link ask; `superseded`: a newer check sent to the same person replaced this one).
38
39
  */
39
40
  export type VerificationGetStatusStatus = OpenEnum<
40
41
  typeof VerificationGetStatusStatus
@@ -59,23 +60,6 @@ export type Metadata = {
59
60
  parentRequestId?: string | null | undefined;
60
61
  };
61
62
 
62
- /**
63
- * Why a request ended `failed`. Null while pending and on success. `already_trusted`: this BotShield ID already secures another account on your platform. `rebind_requires_prior_id`: this account is already secured by another BotShield ID. `pass_limit_reached`: the person has used the passes the gate allows. `real_days_not_met`: the BotShield ID has not yet proved a person on as many days as the gate asks. `unavailable`: the standard Unavailable result.
64
- */
65
- export const VerificationGetStatusReason = {
66
- AlreadyTrusted: "already_trusted",
67
- RebindRequiresPriorId: "rebind_requires_prior_id",
68
- PassLimitReached: "pass_limit_reached",
69
- RealDaysNotMet: "real_days_not_met",
70
- Unavailable: "unavailable",
71
- } as const;
72
- /**
73
- * Why a request ended `failed`. Null while pending and on success. `already_trusted`: this BotShield ID already secures another account on your platform. `rebind_requires_prior_id`: this account is already secured by another BotShield ID. `pass_limit_reached`: the person has used the passes the gate allows. `real_days_not_met`: the BotShield ID has not yet proved a person on as many days as the gate asks. `unavailable`: the standard Unavailable result.
74
- */
75
- export type VerificationGetStatusReason = OpenEnum<
76
- typeof VerificationGetStatusReason
77
- >;
78
-
79
63
  export const VerificationGetStatusPreset = {
80
64
  Presale: "presale",
81
65
  Promo: "promo",
@@ -138,7 +122,7 @@ export type Gate = {
138
122
  linked?: boolean | null | undefined;
139
123
  signedUpRequired?: boolean | undefined;
140
124
  /**
141
- * Passes per person. Null = as often as they like.
125
+ * Passes per BotShield ID. Null = as often as they like.
142
126
  */
143
127
  perPerson?: models.PassesPerPerson | null | undefined;
144
128
  /**
@@ -169,10 +153,38 @@ export type VerificationGetStatusAction = {
169
153
  linked: boolean | null;
170
154
  };
171
155
 
156
+ /**
157
+ * The gate kind this request runs. `human` on every non-gate request.
158
+ */
159
+ export const VerificationGetStatusGateType = {
160
+ Human: "human",
161
+ Age: "age",
162
+ } as const;
163
+ /**
164
+ * The gate kind this request runs. `human` on every non-gate request.
165
+ */
166
+ export type VerificationGetStatusGateType = OpenEnum<
167
+ typeof VerificationGetStatusGateType
168
+ >;
169
+
170
+ /**
171
+ * 4.0: where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
172
+ */
173
+ export const LinkState = {
174
+ Pending: "pending",
175
+ Live: "live",
176
+ Expired: "expired",
177
+ Refused: "refused",
178
+ } as const;
179
+ /**
180
+ * 4.0: where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
181
+ */
182
+ export type LinkState = OpenEnum<typeof LinkState>;
183
+
172
184
  export type VerificationGetStatusData = {
173
185
  found?: boolean | undefined;
174
186
  /**
175
- * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`.
187
+ * `pass` is legacy: a success recorded without a new confirmation on the phone. Gates always ask in 3.3, so new requests end `completed`. A `pass` record expires 60 seconds after the check, after which this endpoint reports `expired`. `cancelled`: the request ended without an answer; see `reason` (`declined`: the person cancelled the link ask; `superseded`: a newer check sent to the same person replaced this one).
176
188
  */
177
189
  status?: VerificationGetStatusStatus | undefined;
178
190
  requestId?: string | undefined;
@@ -202,9 +214,9 @@ export type VerificationGetStatusData = {
202
214
  */
203
215
  error?: models.ErrorBody | undefined;
204
216
  /**
205
- * Why a request ended `failed`. Null while pending and on success. `already_trusted`: this BotShield ID already secures another account on your platform. `rebind_requires_prior_id`: this account is already secured by another BotShield ID. `pass_limit_reached`: the person has used the passes the gate allows. `real_days_not_met`: the BotShield ID has not yet proved a person on as many days as the gate asks. `unavailable`: the standard Unavailable result.
217
+ * Why a request ended `failed` or `cancelled`. Null while pending and on success. An open set — treat unknown values as `unavailable`. `already_trusted`: this BotShield ID already secures another account on your platform. `rebind_requires_prior_id`: this account is already secured by another BotShield ID. `pass_limit_reached`: the person has used the passes the gate allows. `real_days_not_met`: the BotShield ID has not yet proved a person on as many days as the gate asks. `gate_not_open`, `signup_required`, `link_requires_user_ref`: the gate's policy refused. `action_off`: the BotShield Action was turned off mid-tap. `action_requires_user_ref`: an action request without a linking ceremony. `superseded`: a newer check you sent to the same person replaced this one (status `cancelled`). `unavailable`: the standard Unavailable result.
206
218
  */
207
- reason?: VerificationGetStatusReason | null | undefined;
219
+ reason?: string | null | undefined;
208
220
  /**
209
221
  * GA 3.0: on a completed ceremony, whether an active Secured Account binding exists for (your platform, platform-user-ref). Null until completed.
210
222
  */
@@ -229,6 +241,43 @@ export type VerificationGetStatusData = {
229
241
  * BotShield Actions: what this tap confirms. Null on every non-action request. The `act` string itself is never shown here.
230
242
  */
231
243
  action?: VerificationGetStatusAction | null | undefined;
244
+ /**
245
+ * Your organization's mark (logo) URL, if set.
246
+ */
247
+ organizationMarkUrl?: string | null | undefined;
248
+ /**
249
+ * Number matching: the number the screen shows once the phone has scanned, while the request waits for the person's pick. Null otherwise.
250
+ */
251
+ matchNumber?: number | null | undefined;
252
+ /**
253
+ * The gate kind this request runs. `human` on every non-gate request.
254
+ */
255
+ gateType?: VerificationGetStatusGateType | undefined;
256
+ /**
257
+ * Age Gate only: the threshold asked (13, 18 or 21).
258
+ */
259
+ ageThreshold?: number | null | undefined;
260
+ /**
261
+ * Age Gate only, once completed. Positive-only: `over_<n>` or `unavailable`.
262
+ */
263
+ ageVerdict?: string | null | undefined;
264
+ /**
265
+ * Age Gate only, once completed: where the age answer came from.
266
+ */
267
+ ageSource?: string | null | undefined;
268
+ /**
269
+ * 4.0: where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
270
+ */
271
+ linkState?: LinkState | null | undefined;
272
+ /**
273
+ * 4.0: when a pending link expires (24 hours after the tap). Null unless `link_state` is `pending`.
274
+ */
275
+ linkExpiresAt?: Date | null | undefined;
276
+ /**
277
+ * 4.0: `link_pending` while the link waits for your server.
278
+ */
279
+ linkCode?: string | undefined;
280
+ linkMessage?: string | undefined;
232
281
  };
233
282
 
234
283
  /**
@@ -416,19 +465,6 @@ export function metadataFromJSON(
416
465
  );
417
466
  }
418
467
 
419
- /** @internal */
420
- export const VerificationGetStatusReason$inboundSchema: z.ZodType<
421
- VerificationGetStatusReason,
422
- z.ZodTypeDef,
423
- unknown
424
- > = openEnums.inboundSchema(VerificationGetStatusReason);
425
- /** @internal */
426
- export const VerificationGetStatusReason$outboundSchema: z.ZodType<
427
- string,
428
- z.ZodTypeDef,
429
- VerificationGetStatusReason
430
- > = openEnums.outboundSchema(VerificationGetStatusReason);
431
-
432
468
  /** @internal */
433
469
  export const VerificationGetStatusPreset$inboundSchema: z.ZodType<
434
470
  VerificationGetStatusPreset,
@@ -601,6 +637,32 @@ export function verificationGetStatusActionFromJSON(
601
637
  );
602
638
  }
603
639
 
640
+ /** @internal */
641
+ export const VerificationGetStatusGateType$inboundSchema: z.ZodType<
642
+ VerificationGetStatusGateType,
643
+ z.ZodTypeDef,
644
+ unknown
645
+ > = openEnums.inboundSchema(VerificationGetStatusGateType);
646
+ /** @internal */
647
+ export const VerificationGetStatusGateType$outboundSchema: z.ZodType<
648
+ string,
649
+ z.ZodTypeDef,
650
+ VerificationGetStatusGateType
651
+ > = openEnums.outboundSchema(VerificationGetStatusGateType);
652
+
653
+ /** @internal */
654
+ export const LinkState$inboundSchema: z.ZodType<
655
+ LinkState,
656
+ z.ZodTypeDef,
657
+ unknown
658
+ > = openEnums.inboundSchema(LinkState);
659
+ /** @internal */
660
+ export const LinkState$outboundSchema: z.ZodType<
661
+ string,
662
+ z.ZodTypeDef,
663
+ LinkState
664
+ > = openEnums.outboundSchema(LinkState);
665
+
604
666
  /** @internal */
605
667
  export const VerificationGetStatusData$inboundSchema: z.ZodType<
606
668
  VerificationGetStatusData,
@@ -623,7 +685,7 @@ export const VerificationGetStatusData$inboundSchema: z.ZodType<
623
685
  metadata: z.nullable(z.lazy(() => Metadata$inboundSchema)).optional(),
624
686
  message: types.optional(types.string()),
625
687
  error: types.optional(models.ErrorBody$inboundSchema),
626
- reason: z.nullable(VerificationGetStatusReason$inboundSchema).optional(),
688
+ reason: z.nullable(types.string()).optional(),
627
689
  trusted: z.nullable(types.boolean()).optional(),
628
690
  first_time: z.nullable(types.boolean()).optional(),
629
691
  notarize: types.optional(types.boolean()),
@@ -631,6 +693,16 @@ export const VerificationGetStatusData$inboundSchema: z.ZodType<
631
693
  gate: z.nullable(z.lazy(() => Gate$inboundSchema)).optional(),
632
694
  action: z.nullable(z.lazy(() => VerificationGetStatusAction$inboundSchema))
633
695
  .optional(),
696
+ organization_mark_url: z.nullable(types.string()).optional(),
697
+ match_number: z.nullable(types.number()).optional(),
698
+ gate_type: types.optional(VerificationGetStatusGateType$inboundSchema),
699
+ age_threshold: z.nullable(types.number()).optional(),
700
+ age_verdict: z.nullable(types.string()).optional(),
701
+ age_source: z.nullable(types.string()).optional(),
702
+ link_state: z.nullable(LinkState$inboundSchema).optional(),
703
+ link_expires_at: z.nullable(types.date()).optional(),
704
+ link_code: types.optional(types.string()),
705
+ link_message: types.optional(types.string()),
634
706
  }).transform((v) => {
635
707
  return remap$(v, {
636
708
  "request_id": "requestId",
@@ -645,6 +717,16 @@ export const VerificationGetStatusData$inboundSchema: z.ZodType<
645
717
  "presence_address": "presenceAddress",
646
718
  "first_time": "firstTime",
647
719
  "organization_name": "organizationName",
720
+ "organization_mark_url": "organizationMarkUrl",
721
+ "match_number": "matchNumber",
722
+ "gate_type": "gateType",
723
+ "age_threshold": "ageThreshold",
724
+ "age_verdict": "ageVerdict",
725
+ "age_source": "ageSource",
726
+ "link_state": "linkState",
727
+ "link_expires_at": "linkExpiresAt",
728
+ "link_code": "linkCode",
729
+ "link_message": "linkMessage",
648
730
  });
649
731
  });
650
732
  /** @internal */
@@ -672,6 +754,16 @@ export type VerificationGetStatusData$Outbound = {
672
754
  organization_name?: string | null | undefined;
673
755
  gate?: Gate$Outbound | null | undefined;
674
756
  action?: VerificationGetStatusAction$Outbound | null | undefined;
757
+ organization_mark_url?: string | null | undefined;
758
+ match_number?: number | null | undefined;
759
+ gate_type?: string | undefined;
760
+ age_threshold?: number | null | undefined;
761
+ age_verdict?: string | null | undefined;
762
+ age_source?: string | null | undefined;
763
+ link_state?: string | null | undefined;
764
+ link_expires_at?: string | null | undefined;
765
+ link_code?: string | undefined;
766
+ link_message?: string | undefined;
675
767
  };
676
768
 
677
769
  /** @internal */
@@ -696,7 +788,7 @@ export const VerificationGetStatusData$outboundSchema: z.ZodType<
696
788
  metadata: z.nullable(z.lazy(() => Metadata$outboundSchema)).optional(),
697
789
  message: z.string().optional(),
698
790
  error: models.ErrorBody$outboundSchema.optional(),
699
- reason: z.nullable(VerificationGetStatusReason$outboundSchema).optional(),
791
+ reason: z.nullable(z.string()).optional(),
700
792
  trusted: z.nullable(z.boolean()).optional(),
701
793
  firstTime: z.nullable(z.boolean()).optional(),
702
794
  notarize: z.boolean().optional(),
@@ -704,6 +796,17 @@ export const VerificationGetStatusData$outboundSchema: z.ZodType<
704
796
  gate: z.nullable(z.lazy(() => Gate$outboundSchema)).optional(),
705
797
  action: z.nullable(z.lazy(() => VerificationGetStatusAction$outboundSchema))
706
798
  .optional(),
799
+ organizationMarkUrl: z.nullable(z.string()).optional(),
800
+ matchNumber: z.nullable(z.number().int()).optional(),
801
+ gateType: VerificationGetStatusGateType$outboundSchema.optional(),
802
+ ageThreshold: z.nullable(z.number().int()).optional(),
803
+ ageVerdict: z.nullable(z.string()).optional(),
804
+ ageSource: z.nullable(z.string()).optional(),
805
+ linkState: z.nullable(LinkState$outboundSchema).optional(),
806
+ linkExpiresAt: z.nullable(z.date().transform(v => v.toISOString()))
807
+ .optional(),
808
+ linkCode: z.string().optional(),
809
+ linkMessage: z.string().optional(),
707
810
  }).transform((v) => {
708
811
  return remap$(v, {
709
812
  requestId: "request_id",
@@ -718,6 +821,16 @@ export const VerificationGetStatusData$outboundSchema: z.ZodType<
718
821
  presenceAddress: "presence_address",
719
822
  firstTime: "first_time",
720
823
  organizationName: "organization_name",
824
+ organizationMarkUrl: "organization_mark_url",
825
+ matchNumber: "match_number",
826
+ gateType: "gate_type",
827
+ ageThreshold: "age_threshold",
828
+ ageVerdict: "age_verdict",
829
+ ageSource: "age_source",
830
+ linkState: "link_state",
831
+ linkExpiresAt: "link_expires_at",
832
+ linkCode: "link_code",
833
+ linkMessage: "link_message",
721
834
  });
722
835
  });
723
836
 
@@ -19,7 +19,7 @@ export const Window = {
19
19
  export type Window = OpenEnum<typeof Window>;
20
20
 
21
21
  /**
22
- * Passes per person on your platform: `limit` per `window` (`30d` = rolling 30 days, `ever` = lifetime).
22
+ * Passes per BotShield ID on your platform: `limit` per `window` (`30d` = rolling 30 days, `ever` = lifetime).
23
23
  */
24
24
  export type PassesPerPerson = {
25
25
  limit: number;
@@ -5,16 +5,36 @@
5
5
  import { actionsCancelAction } from "../funcs/actions-cancel-action.js";
6
6
  import { actionsCheckActionStatus } from "../funcs/actions-check-action-status.js";
7
7
  import { actionsProposeAction } from "../funcs/actions-propose-action.js";
8
+ import { actionsVerifyResolution } from "../funcs/actions-verify-resolution.js";
8
9
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
9
10
  import * as operations from "../models/operations/index.js";
10
11
  import { unwrapAsync } from "../types/fp.js";
11
12
 
12
13
  export class Actions extends ClientSDK {
14
+ /**
15
+ * Check a Proof of Resolution (works once)
16
+ *
17
+ * @remarks
18
+ * 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).
19
+ */
20
+ async verifyResolution(
21
+ security: operations.SDKVerifyResolutionSecurity,
22
+ request: operations.SDKVerifyResolutionRequest,
23
+ options?: RequestOptions,
24
+ ): Promise<operations.SDKVerifyResolutionResponse> {
25
+ return unwrapAsync(actionsVerifyResolution(
26
+ this,
27
+ security,
28
+ request,
29
+ options,
30
+ ));
31
+ }
32
+
13
33
  /**
14
34
  * Propose an action for human confirmation
15
35
  *
16
36
  * @remarks
17
- * 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.
37
+ * 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).
18
38
  */
19
39
  async proposeAction(
20
40
  request: operations.ActionsProposeRequest,