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,380 @@
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 type SDKConfirmLinkSecurity = {
14
+ apiKeyAuth: string;
15
+ };
16
+
17
+ export type SDKConfirmLinkRequest = {
18
+ /**
19
+ * The request the person tapped (req_…).
20
+ */
21
+ requestId: string;
22
+ /**
23
+ * The account your own session shows — the same id you started the link with.
24
+ */
25
+ partnerUserRef?: string | undefined;
26
+ /**
27
+ * Alias of partner_user_ref.
28
+ */
29
+ partnerUserId?: string | undefined;
30
+ };
31
+
32
+ export const SDKConfirmLinkState = {
33
+ Live: "live",
34
+ } as const;
35
+ export type SDKConfirmLinkState = ClosedEnum<typeof SDKConfirmLinkState>;
36
+
37
+ export type SDKConfirmLinkDataData = {
38
+ linked?: boolean | undefined;
39
+ state?: SDKConfirmLinkState | undefined;
40
+ firstTime?: boolean | undefined;
41
+ requestId?: string | undefined;
42
+ handle?: string | undefined;
43
+ trusted?: boolean | undefined;
44
+ trustedSince?: Date | undefined;
45
+ /**
46
+ * The finished token. Single use, 2 minutes.
47
+ */
48
+ verificationToken?: string | undefined;
49
+ };
50
+
51
+ export type SDKConfirmLinkError = {
52
+ code?: string | undefined;
53
+ message?: string | undefined;
54
+ statusCode?: number | undefined;
55
+ };
56
+
57
+ export type SDKConfirmLinkData = {
58
+ data?: SDKConfirmLinkDataData | undefined;
59
+ error?: SDKConfirmLinkError | undefined;
60
+ };
61
+
62
+ /**
63
+ * Result. NOTE: handler errors arrive here (HTTP 200) as data.error — codes: secret_key_required · invalid_key · account_required · link_not_found · environment_mismatch · link_account_mismatch · link_expired · link_refused · rebind_requires_prior_id · already_trusted · unavailable.
64
+ */
65
+ export type SDKConfirmLinkResponse = {
66
+ data?: SDKConfirmLinkData | undefined;
67
+ };
68
+
69
+ /** @internal */
70
+ export const SDKConfirmLinkSecurity$inboundSchema: z.ZodType<
71
+ SDKConfirmLinkSecurity,
72
+ z.ZodTypeDef,
73
+ unknown
74
+ > = z.object({
75
+ ApiKeyAuth: types.string(),
76
+ }).transform((v) => {
77
+ return remap$(v, {
78
+ "ApiKeyAuth": "apiKeyAuth",
79
+ });
80
+ });
81
+ /** @internal */
82
+ export type SDKConfirmLinkSecurity$Outbound = {
83
+ ApiKeyAuth: string;
84
+ };
85
+
86
+ /** @internal */
87
+ export const SDKConfirmLinkSecurity$outboundSchema: z.ZodType<
88
+ SDKConfirmLinkSecurity$Outbound,
89
+ z.ZodTypeDef,
90
+ SDKConfirmLinkSecurity
91
+ > = z.object({
92
+ apiKeyAuth: z.string(),
93
+ }).transform((v) => {
94
+ return remap$(v, {
95
+ apiKeyAuth: "ApiKeyAuth",
96
+ });
97
+ });
98
+
99
+ export function sdkConfirmLinkSecurityToJSON(
100
+ sdkConfirmLinkSecurity: SDKConfirmLinkSecurity,
101
+ ): string {
102
+ return JSON.stringify(
103
+ SDKConfirmLinkSecurity$outboundSchema.parse(sdkConfirmLinkSecurity),
104
+ );
105
+ }
106
+ export function sdkConfirmLinkSecurityFromJSON(
107
+ jsonString: string,
108
+ ): SafeParseResult<SDKConfirmLinkSecurity, SDKValidationError> {
109
+ return safeParse(
110
+ jsonString,
111
+ (x) => SDKConfirmLinkSecurity$inboundSchema.parse(JSON.parse(x)),
112
+ `Failed to parse 'SDKConfirmLinkSecurity' from JSON`,
113
+ );
114
+ }
115
+
116
+ /** @internal */
117
+ export const SDKConfirmLinkRequest$inboundSchema: z.ZodType<
118
+ SDKConfirmLinkRequest,
119
+ z.ZodTypeDef,
120
+ unknown
121
+ > = z.object({
122
+ request_id: types.string(),
123
+ partner_user_ref: types.optional(types.string()),
124
+ partner_user_id: types.optional(types.string()),
125
+ }).transform((v) => {
126
+ return remap$(v, {
127
+ "request_id": "requestId",
128
+ "partner_user_ref": "partnerUserRef",
129
+ "partner_user_id": "partnerUserId",
130
+ });
131
+ });
132
+ /** @internal */
133
+ export type SDKConfirmLinkRequest$Outbound = {
134
+ request_id: string;
135
+ partner_user_ref?: string | undefined;
136
+ partner_user_id?: string | undefined;
137
+ };
138
+
139
+ /** @internal */
140
+ export const SDKConfirmLinkRequest$outboundSchema: z.ZodType<
141
+ SDKConfirmLinkRequest$Outbound,
142
+ z.ZodTypeDef,
143
+ SDKConfirmLinkRequest
144
+ > = z.object({
145
+ requestId: z.string(),
146
+ partnerUserRef: z.string().optional(),
147
+ partnerUserId: z.string().optional(),
148
+ }).transform((v) => {
149
+ return remap$(v, {
150
+ requestId: "request_id",
151
+ partnerUserRef: "partner_user_ref",
152
+ partnerUserId: "partner_user_id",
153
+ });
154
+ });
155
+
156
+ export function sdkConfirmLinkRequestToJSON(
157
+ sdkConfirmLinkRequest: SDKConfirmLinkRequest,
158
+ ): string {
159
+ return JSON.stringify(
160
+ SDKConfirmLinkRequest$outboundSchema.parse(sdkConfirmLinkRequest),
161
+ );
162
+ }
163
+ export function sdkConfirmLinkRequestFromJSON(
164
+ jsonString: string,
165
+ ): SafeParseResult<SDKConfirmLinkRequest, SDKValidationError> {
166
+ return safeParse(
167
+ jsonString,
168
+ (x) => SDKConfirmLinkRequest$inboundSchema.parse(JSON.parse(x)),
169
+ `Failed to parse 'SDKConfirmLinkRequest' from JSON`,
170
+ );
171
+ }
172
+
173
+ /** @internal */
174
+ export const SDKConfirmLinkState$inboundSchema: z.ZodNativeEnum<
175
+ typeof SDKConfirmLinkState
176
+ > = z.nativeEnum(SDKConfirmLinkState);
177
+ /** @internal */
178
+ export const SDKConfirmLinkState$outboundSchema: z.ZodNativeEnum<
179
+ typeof SDKConfirmLinkState
180
+ > = SDKConfirmLinkState$inboundSchema;
181
+
182
+ /** @internal */
183
+ export const SDKConfirmLinkDataData$inboundSchema: z.ZodType<
184
+ SDKConfirmLinkDataData,
185
+ z.ZodTypeDef,
186
+ unknown
187
+ > = z.object({
188
+ linked: types.optional(types.boolean()),
189
+ state: types.optional(SDKConfirmLinkState$inboundSchema),
190
+ first_time: types.optional(types.boolean()),
191
+ request_id: types.optional(types.string()),
192
+ handle: types.optional(types.string()),
193
+ trusted: types.optional(types.boolean()),
194
+ trusted_since: types.optional(types.date()),
195
+ verification_token: types.optional(types.string()),
196
+ }).transform((v) => {
197
+ return remap$(v, {
198
+ "first_time": "firstTime",
199
+ "request_id": "requestId",
200
+ "trusted_since": "trustedSince",
201
+ "verification_token": "verificationToken",
202
+ });
203
+ });
204
+ /** @internal */
205
+ export type SDKConfirmLinkDataData$Outbound = {
206
+ linked?: boolean | undefined;
207
+ state?: string | undefined;
208
+ first_time?: boolean | undefined;
209
+ request_id?: string | undefined;
210
+ handle?: string | undefined;
211
+ trusted?: boolean | undefined;
212
+ trusted_since?: string | undefined;
213
+ verification_token?: string | undefined;
214
+ };
215
+
216
+ /** @internal */
217
+ export const SDKConfirmLinkDataData$outboundSchema: z.ZodType<
218
+ SDKConfirmLinkDataData$Outbound,
219
+ z.ZodTypeDef,
220
+ SDKConfirmLinkDataData
221
+ > = z.object({
222
+ linked: z.boolean().optional(),
223
+ state: SDKConfirmLinkState$outboundSchema.optional(),
224
+ firstTime: z.boolean().optional(),
225
+ requestId: z.string().optional(),
226
+ handle: z.string().optional(),
227
+ trusted: z.boolean().optional(),
228
+ trustedSince: z.date().transform(v => v.toISOString()).optional(),
229
+ verificationToken: z.string().optional(),
230
+ }).transform((v) => {
231
+ return remap$(v, {
232
+ firstTime: "first_time",
233
+ requestId: "request_id",
234
+ trustedSince: "trusted_since",
235
+ verificationToken: "verification_token",
236
+ });
237
+ });
238
+
239
+ export function sdkConfirmLinkDataDataToJSON(
240
+ sdkConfirmLinkDataData: SDKConfirmLinkDataData,
241
+ ): string {
242
+ return JSON.stringify(
243
+ SDKConfirmLinkDataData$outboundSchema.parse(sdkConfirmLinkDataData),
244
+ );
245
+ }
246
+ export function sdkConfirmLinkDataDataFromJSON(
247
+ jsonString: string,
248
+ ): SafeParseResult<SDKConfirmLinkDataData, SDKValidationError> {
249
+ return safeParse(
250
+ jsonString,
251
+ (x) => SDKConfirmLinkDataData$inboundSchema.parse(JSON.parse(x)),
252
+ `Failed to parse 'SDKConfirmLinkDataData' from JSON`,
253
+ );
254
+ }
255
+
256
+ /** @internal */
257
+ export const SDKConfirmLinkError$inboundSchema: z.ZodType<
258
+ SDKConfirmLinkError,
259
+ z.ZodTypeDef,
260
+ unknown
261
+ > = z.object({
262
+ code: types.optional(types.string()),
263
+ message: types.optional(types.string()),
264
+ statusCode: types.optional(types.number()),
265
+ });
266
+ /** @internal */
267
+ export type SDKConfirmLinkError$Outbound = {
268
+ code?: string | undefined;
269
+ message?: string | undefined;
270
+ statusCode?: number | undefined;
271
+ };
272
+
273
+ /** @internal */
274
+ export const SDKConfirmLinkError$outboundSchema: z.ZodType<
275
+ SDKConfirmLinkError$Outbound,
276
+ z.ZodTypeDef,
277
+ SDKConfirmLinkError
278
+ > = z.object({
279
+ code: z.string().optional(),
280
+ message: z.string().optional(),
281
+ statusCode: z.number().int().optional(),
282
+ });
283
+
284
+ export function sdkConfirmLinkErrorToJSON(
285
+ sdkConfirmLinkError: SDKConfirmLinkError,
286
+ ): string {
287
+ return JSON.stringify(
288
+ SDKConfirmLinkError$outboundSchema.parse(sdkConfirmLinkError),
289
+ );
290
+ }
291
+ export function sdkConfirmLinkErrorFromJSON(
292
+ jsonString: string,
293
+ ): SafeParseResult<SDKConfirmLinkError, SDKValidationError> {
294
+ return safeParse(
295
+ jsonString,
296
+ (x) => SDKConfirmLinkError$inboundSchema.parse(JSON.parse(x)),
297
+ `Failed to parse 'SDKConfirmLinkError' from JSON`,
298
+ );
299
+ }
300
+
301
+ /** @internal */
302
+ export const SDKConfirmLinkData$inboundSchema: z.ZodType<
303
+ SDKConfirmLinkData,
304
+ z.ZodTypeDef,
305
+ unknown
306
+ > = z.object({
307
+ data: types.optional(z.lazy(() => SDKConfirmLinkDataData$inboundSchema)),
308
+ error: types.optional(z.lazy(() => SDKConfirmLinkError$inboundSchema)),
309
+ });
310
+ /** @internal */
311
+ export type SDKConfirmLinkData$Outbound = {
312
+ data?: SDKConfirmLinkDataData$Outbound | undefined;
313
+ error?: SDKConfirmLinkError$Outbound | undefined;
314
+ };
315
+
316
+ /** @internal */
317
+ export const SDKConfirmLinkData$outboundSchema: z.ZodType<
318
+ SDKConfirmLinkData$Outbound,
319
+ z.ZodTypeDef,
320
+ SDKConfirmLinkData
321
+ > = z.object({
322
+ data: z.lazy(() => SDKConfirmLinkDataData$outboundSchema).optional(),
323
+ error: z.lazy(() => SDKConfirmLinkError$outboundSchema).optional(),
324
+ });
325
+
326
+ export function sdkConfirmLinkDataToJSON(
327
+ sdkConfirmLinkData: SDKConfirmLinkData,
328
+ ): string {
329
+ return JSON.stringify(
330
+ SDKConfirmLinkData$outboundSchema.parse(sdkConfirmLinkData),
331
+ );
332
+ }
333
+ export function sdkConfirmLinkDataFromJSON(
334
+ jsonString: string,
335
+ ): SafeParseResult<SDKConfirmLinkData, SDKValidationError> {
336
+ return safeParse(
337
+ jsonString,
338
+ (x) => SDKConfirmLinkData$inboundSchema.parse(JSON.parse(x)),
339
+ `Failed to parse 'SDKConfirmLinkData' from JSON`,
340
+ );
341
+ }
342
+
343
+ /** @internal */
344
+ export const SDKConfirmLinkResponse$inboundSchema: z.ZodType<
345
+ SDKConfirmLinkResponse,
346
+ z.ZodTypeDef,
347
+ unknown
348
+ > = z.object({
349
+ data: types.optional(z.lazy(() => SDKConfirmLinkData$inboundSchema)),
350
+ });
351
+ /** @internal */
352
+ export type SDKConfirmLinkResponse$Outbound = {
353
+ data?: SDKConfirmLinkData$Outbound | undefined;
354
+ };
355
+
356
+ /** @internal */
357
+ export const SDKConfirmLinkResponse$outboundSchema: z.ZodType<
358
+ SDKConfirmLinkResponse$Outbound,
359
+ z.ZodTypeDef,
360
+ SDKConfirmLinkResponse
361
+ > = z.object({
362
+ data: z.lazy(() => SDKConfirmLinkData$outboundSchema).optional(),
363
+ });
364
+
365
+ export function sdkConfirmLinkResponseToJSON(
366
+ sdkConfirmLinkResponse: SDKConfirmLinkResponse,
367
+ ): string {
368
+ return JSON.stringify(
369
+ SDKConfirmLinkResponse$outboundSchema.parse(sdkConfirmLinkResponse),
370
+ );
371
+ }
372
+ export function sdkConfirmLinkResponseFromJSON(
373
+ jsonString: string,
374
+ ): SafeParseResult<SDKConfirmLinkResponse, SDKValidationError> {
375
+ return safeParse(
376
+ jsonString,
377
+ (x) => SDKConfirmLinkResponse$inboundSchema.parse(JSON.parse(x)),
378
+ `Failed to parse 'SDKConfirmLinkResponse' from JSON`,
379
+ );
380
+ }
@@ -100,7 +100,7 @@ export type SDKCreateSessionData = {
100
100
  };
101
101
 
102
102
  /**
103
- * Anchor grant window created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 401 (bad or missing credential), 403 (origin not allowed for the site key).
103
+ * Anchor grant window created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 401 (bad or missing credential), 403 (origin not allowed for the site key; also a production site key with no allowed origins, which is refused until you add your domain to the key in the Console).
104
104
  */
105
105
  export type SDKCreateSessionResponse = {
106
106
  data: SDKCreateSessionData;
@@ -97,7 +97,7 @@ export type SDKCreateVerificationLinkRequest = {
97
97
  */
98
98
  act?: string | undefined;
99
99
  /**
100
- * What the person is confirming, shown verbatim on their card (e.g. "Trade with sam_k — 2 GA for $180"). Only with `act` (`act_label_without_act`). Display only — it is NOT in the token; bind terms through `act` (e.g. a hash of them), which the token carries.
100
+ * What the person is confirming, shown verbatim on their card (e.g. "Trade with sam_k — 2 GA for $180"). Only with `act` (`act_label_without_act`). Plain words only: a link, a domain or a URI scheme is refused (`act_label_has_link`). Display only — it is NOT in the token; bind terms through `act` (e.g. a hash of them), which the token carries.
101
101
  */
102
102
  actLabel?: string | undefined;
103
103
  };
@@ -120,6 +120,31 @@ export type SDKCreateVerificationLinkOrganization = {
120
120
  id?: string | undefined;
121
121
  };
122
122
 
123
+ /**
124
+ * Present when you sent `partner_user_ref`. `pushed`: the customer's phone was asked. `not_delivered`: nothing was pushed (the customer has turned off checks from you, has no phone set up, or the push was skipped or could not be sent; see `push_skipped`). The check still exists and still answers. `not_linked`: this account is not verified with BotShield, so nothing was pushed.
125
+ */
126
+ export const Delivery = {
127
+ Pushed: "pushed",
128
+ NotDelivered: "not_delivered",
129
+ NotLinked: "not_linked",
130
+ } as const;
131
+ /**
132
+ * Present when you sent `partner_user_ref`. `pushed`: the customer's phone was asked. `not_delivered`: nothing was pushed (the customer has turned off checks from you, has no phone set up, or the push was skipped or could not be sent; see `push_skipped`). The check still exists and still answers. `not_linked`: this account is not verified with BotShield, so nothing was pushed.
133
+ */
134
+ export type Delivery = OpenEnum<typeof Delivery>;
135
+
136
+ /**
137
+ * Present only when the account is linked but its phones were not pushed for one of these reasons. `daily_cap`: you have sent this customer the most checks allowed in 24 hours. `unavailable`: BotShield could not read this customer's recent checks, so it pushed nothing (fails closed). The request is still created either way.
138
+ */
139
+ export const PushSkipped = {
140
+ DailyCap: "daily_cap",
141
+ Unavailable: "unavailable",
142
+ } as const;
143
+ /**
144
+ * Present only when the account is linked but its phones were not pushed for one of these reasons. `daily_cap`: you have sent this customer the most checks allowed in 24 hours. `unavailable`: BotShield could not read this customer's recent checks, so it pushed nothing (fails closed). The request is still created either way.
145
+ */
146
+ export type PushSkipped = OpenEnum<typeof PushSkipped>;
147
+
123
148
  /**
124
149
  * The gate's type. An Age Gate never notarizes (widget suppresses the chip).
125
150
  */
@@ -166,6 +191,10 @@ export type SDKCreateVerificationLinkNotarizeFallbackReason = OpenEnum<
166
191
 
167
192
  export type SDKCreateVerificationLinkDataData = {
168
193
  requestId: string;
194
+ /**
195
+ * 4.0: only on a request started with your site key (`pk_…`, a page's grant). The one secret that reads this request's answer: send it as `X-BotShield-Request-Secret` to verification/status, which returns the finished tokens only with it. Returned once, here; BotShield keeps only its hash. A request your server started with its secret key has none (its tokens go to that key).
196
+ */
197
+ readSecret?: string | undefined;
169
198
  deepLink: string;
170
199
  webUrl: string;
171
200
  /**
@@ -188,6 +217,14 @@ export type SDKCreateVerificationLinkDataData = {
188
217
  * Number of the user's registered devices the request was pushed to (0 when the user is unknown or has no devices).
189
218
  */
190
219
  pushedToDevices: number;
220
+ /**
221
+ * Present when you sent `partner_user_ref`. `pushed`: the customer's phone was asked. `not_delivered`: nothing was pushed (the customer has turned off checks from you, has no phone set up, or the push was skipped or could not be sent; see `push_skipped`). The check still exists and still answers. `not_linked`: this account is not verified with BotShield, so nothing was pushed.
222
+ */
223
+ delivery?: Delivery | undefined;
224
+ /**
225
+ * Present only when the account is linked but its phones were not pushed for one of these reasons. `daily_cap`: you have sent this customer the most checks allowed in 24 hours. `unavailable`: BotShield could not read this customer's recent checks, so it pushed nothing (fails closed). The request is still created either way.
226
+ */
227
+ pushSkipped?: PushSkipped | undefined;
191
228
  /**
192
229
  * The gate's type. An Age Gate never notarizes (widget suppresses the chip).
193
230
  */
@@ -225,7 +262,7 @@ export type SDKCreateVerificationLinkData = {
225
262
  };
226
263
 
227
264
  /**
228
- * Verification link created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 400 (partner not found / gate not active), 401, 403 (gate not in the token allowlist), 409 (pending request already exists — call revoke-verification). BotShield Actions and linking codes (`data.error.code`): `act_label_without_act` (400), `action_not_a_gate` (400), `action_invalid` (400 — act malformed), `action_not_found` (400 — no action with that key here), `action_off` (409), `action_requires_user_ref` (400), `link_requires_user_ref` (400 — the gate's policy is `link: required` and no partner_user_ref was sent).
265
+ * Verification link created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 400 (partner not found / gate not active), 401, 403 (gate not in the token allowlist), 409 (pending request already exists — call revoke-verification). BotShield Actions and linking codes (`data.error.code`): `act_label_without_act` (400), `act_label_has_link` (400 — `act_label` may not contain a link, a domain or a URI scheme), `action_not_a_gate` (400), `action_invalid` (400 — act malformed), `action_not_found` (400 — no action with that key here), `action_off` (409), `action_requires_user_ref` (400), `link_requires_user_ref` (400 — the gate's policy is `link: required` and no partner_user_ref was sent), `account_reconfirm_required` (409 — the customer changed their phone number without approval from another phone; only the link ceremony (`notarize`) can be started for this partner_user_ref until they confirm the account again from your signed-in page). A development key over its limit: `RATE_LIMITED`. 4.0: `link_requires_server_session` (403 — a request on a site-key grant that would write a NEW link: a `notarize` ceremony, or an `act` on an account not linked here yet; open the session from your server with your secret key, naming the signed-in customer), `account_override_refused` (403 — `partner_user_ref` names a different account from the one the session names), `action_is_recovery` / `action_is_signin` (400 — that `act` is your Recovery Action or your Sign-on Action, which no request starts), and 503 when BotShield could not tell whether the account is already linked (nothing was written; retry).
229
266
  */
230
267
  export type SDKCreateVerificationLinkResponse = {
231
268
  data: SDKCreateVerificationLinkData;
@@ -472,6 +509,32 @@ export function sdkCreateVerificationLinkOrganizationFromJSON(
472
509
  );
473
510
  }
474
511
 
512
+ /** @internal */
513
+ export const Delivery$inboundSchema: z.ZodType<
514
+ Delivery,
515
+ z.ZodTypeDef,
516
+ unknown
517
+ > = openEnums.inboundSchema(Delivery);
518
+ /** @internal */
519
+ export const Delivery$outboundSchema: z.ZodType<
520
+ string,
521
+ z.ZodTypeDef,
522
+ Delivery
523
+ > = openEnums.outboundSchema(Delivery);
524
+
525
+ /** @internal */
526
+ export const PushSkipped$inboundSchema: z.ZodType<
527
+ PushSkipped,
528
+ z.ZodTypeDef,
529
+ unknown
530
+ > = openEnums.inboundSchema(PushSkipped);
531
+ /** @internal */
532
+ export const PushSkipped$outboundSchema: z.ZodType<
533
+ string,
534
+ z.ZodTypeDef,
535
+ PushSkipped
536
+ > = openEnums.outboundSchema(PushSkipped);
537
+
475
538
  /** @internal */
476
539
  export const SDKCreateVerificationLinkGateType$inboundSchema: z.ZodType<
477
540
  SDKCreateVerificationLinkGateType,
@@ -520,6 +583,7 @@ export const SDKCreateVerificationLinkDataData$inboundSchema: z.ZodType<
520
583
  unknown
521
584
  > = z.object({
522
585
  request_id: types.string(),
586
+ read_secret: types.optional(types.string()),
523
587
  deep_link: types.string(),
524
588
  web_url: types.string(),
525
589
  qr_code_url: types.string(),
@@ -533,6 +597,8 @@ export const SDKCreateVerificationLinkDataData$inboundSchema: z.ZodType<
533
597
  z.lazy(() => SDKCreateVerificationLinkOrganization$inboundSchema),
534
598
  ),
535
599
  pushed_to_devices: types.number(),
600
+ delivery: types.optional(Delivery$inboundSchema),
601
+ push_skipped: types.optional(PushSkipped$inboundSchema),
536
602
  gate_type: types.optional(SDKCreateVerificationLinkGateType$inboundSchema),
537
603
  age_threshold: types.optional(
538
604
  SDKCreateVerificationLinkAgeThreshold$inboundSchema,
@@ -546,6 +612,7 @@ export const SDKCreateVerificationLinkDataData$inboundSchema: z.ZodType<
546
612
  }).transform((v) => {
547
613
  return remap$(v, {
548
614
  "request_id": "requestId",
615
+ "read_secret": "readSecret",
549
616
  "deep_link": "deepLink",
550
617
  "web_url": "webUrl",
551
618
  "qr_code_url": "qrCodeUrl",
@@ -553,6 +620,7 @@ export const SDKCreateVerificationLinkDataData$inboundSchema: z.ZodType<
553
620
  "sdk_type": "sdkType",
554
621
  "auth_mode": "authMode",
555
622
  "pushed_to_devices": "pushedToDevices",
623
+ "push_skipped": "pushSkipped",
556
624
  "gate_type": "gateType",
557
625
  "age_threshold": "ageThreshold",
558
626
  "notarize_fallback_reason": "notarizeFallbackReason",
@@ -561,6 +629,7 @@ export const SDKCreateVerificationLinkDataData$inboundSchema: z.ZodType<
561
629
  /** @internal */
562
630
  export type SDKCreateVerificationLinkDataData$Outbound = {
563
631
  request_id: string;
632
+ read_secret?: string | undefined;
564
633
  deep_link: string;
565
634
  web_url: string;
566
635
  qr_code_url: string;
@@ -570,6 +639,8 @@ export type SDKCreateVerificationLinkDataData$Outbound = {
570
639
  scope?: string | undefined;
571
640
  organization?: SDKCreateVerificationLinkOrganization$Outbound | undefined;
572
641
  pushed_to_devices: number;
642
+ delivery?: string | undefined;
643
+ push_skipped?: string | undefined;
573
644
  gate_type?: string | undefined;
574
645
  age_threshold?: number | undefined;
575
646
  trusted?: boolean | undefined;
@@ -585,6 +656,7 @@ export const SDKCreateVerificationLinkDataData$outboundSchema: z.ZodType<
585
656
  SDKCreateVerificationLinkDataData
586
657
  > = z.object({
587
658
  requestId: z.string(),
659
+ readSecret: z.string().optional(),
588
660
  deepLink: z.string(),
589
661
  webUrl: z.string(),
590
662
  qrCodeUrl: z.string(),
@@ -596,6 +668,8 @@ export const SDKCreateVerificationLinkDataData$outboundSchema: z.ZodType<
596
668
  SDKCreateVerificationLinkOrganization$outboundSchema
597
669
  ).optional(),
598
670
  pushedToDevices: z.number().int(),
671
+ delivery: Delivery$outboundSchema.optional(),
672
+ pushSkipped: PushSkipped$outboundSchema.optional(),
599
673
  gateType: SDKCreateVerificationLinkGateType$outboundSchema.optional(),
600
674
  ageThreshold: SDKCreateVerificationLinkAgeThreshold$outboundSchema.optional(),
601
675
  trusted: z.boolean().optional(),
@@ -606,6 +680,7 @@ export const SDKCreateVerificationLinkDataData$outboundSchema: z.ZodType<
606
680
  }).transform((v) => {
607
681
  return remap$(v, {
608
682
  requestId: "request_id",
683
+ readSecret: "read_secret",
609
684
  deepLink: "deep_link",
610
685
  webUrl: "web_url",
611
686
  qrCodeUrl: "qr_code_url",
@@ -613,6 +688,7 @@ export const SDKCreateVerificationLinkDataData$outboundSchema: z.ZodType<
613
688
  sdkType: "sdk_type",
614
689
  authMode: "auth_mode",
615
690
  pushedToDevices: "pushed_to_devices",
691
+ pushSkipped: "push_skipped",
616
692
  gateType: "gate_type",
617
693
  ageThreshold: "age_threshold",
618
694
  notarizeFallbackReason: "notarize_fallback_reason",