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
@@ -0,0 +1,339 @@
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 * as openEnums from "../../types/enums.js";
9
+ import { OpenEnum } from "../../types/enums.js";
10
+ import { Result as SafeParseResult } from "../../types/fp.js";
11
+ import * as types from "../../types/primitives.js";
12
+ import { SDKValidationError } from "../errors/sdk-validation-error.js";
13
+ import * as models from "../index.js";
14
+
15
+ export type GatesApiActionsRequestCancelSecurity = {
16
+ gatesKeyAuth: string;
17
+ };
18
+
19
+ export type GatesApiActionsRequestCancelRequest = {
20
+ /**
21
+ * The request_id you sent.
22
+ */
23
+ requestId: string;
24
+ /**
25
+ * The agent you sent it through.
26
+ */
27
+ agent: string;
28
+ /**
29
+ * For your own audit trail. Never shown to the person.
30
+ */
31
+ reason?: string | undefined;
32
+ };
33
+
34
+ export const GatesApiActionsRequestCancelStatus = {
35
+ Queued: "queued",
36
+ Approved: "approved",
37
+ Denied: "denied",
38
+ Expired: "expired",
39
+ Cancelled: "cancelled",
40
+ } as const;
41
+ export type GatesApiActionsRequestCancelStatus = OpenEnum<
42
+ typeof GatesApiActionsRequestCancelStatus
43
+ >;
44
+
45
+ export type GatesApiActionsRequestCancelDataData = {
46
+ requestId: string;
47
+ status: GatesApiActionsRequestCancelStatus;
48
+ /**
49
+ * True when the request was no longer waiting, so nothing was withdrawn.
50
+ */
51
+ alreadyResolved?: boolean | undefined;
52
+ cancelledAt?: Date | undefined;
53
+ };
54
+
55
+ export type GatesApiActionsRequestCancelData = {
56
+ data?: GatesApiActionsRequestCancelDataData | undefined;
57
+ /**
58
+ * Gates API handler error. Arrives inside `data.error` with HTTP 200 — check for it before reading the result.
59
+ */
60
+ error?: models.GatesApiError | undefined;
61
+ };
62
+
63
+ /**
64
+ * Withdrawn, or the request as it stands when it was no longer waiting. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `org_not_found` (404), `request_not_found` (404), `internal` (500).
65
+ */
66
+ export type GatesApiActionsRequestCancelResponse = {
67
+ data: GatesApiActionsRequestCancelData;
68
+ };
69
+
70
+ /** @internal */
71
+ export const GatesApiActionsRequestCancelSecurity$inboundSchema: z.ZodType<
72
+ GatesApiActionsRequestCancelSecurity,
73
+ z.ZodTypeDef,
74
+ unknown
75
+ > = z.object({
76
+ GatesKeyAuth: types.string(),
77
+ }).transform((v) => {
78
+ return remap$(v, {
79
+ "GatesKeyAuth": "gatesKeyAuth",
80
+ });
81
+ });
82
+ /** @internal */
83
+ export type GatesApiActionsRequestCancelSecurity$Outbound = {
84
+ GatesKeyAuth: string;
85
+ };
86
+
87
+ /** @internal */
88
+ export const GatesApiActionsRequestCancelSecurity$outboundSchema: z.ZodType<
89
+ GatesApiActionsRequestCancelSecurity$Outbound,
90
+ z.ZodTypeDef,
91
+ GatesApiActionsRequestCancelSecurity
92
+ > = z.object({
93
+ gatesKeyAuth: z.string(),
94
+ }).transform((v) => {
95
+ return remap$(v, {
96
+ gatesKeyAuth: "GatesKeyAuth",
97
+ });
98
+ });
99
+
100
+ export function gatesApiActionsRequestCancelSecurityToJSON(
101
+ gatesApiActionsRequestCancelSecurity: GatesApiActionsRequestCancelSecurity,
102
+ ): string {
103
+ return JSON.stringify(
104
+ GatesApiActionsRequestCancelSecurity$outboundSchema.parse(
105
+ gatesApiActionsRequestCancelSecurity,
106
+ ),
107
+ );
108
+ }
109
+ export function gatesApiActionsRequestCancelSecurityFromJSON(
110
+ jsonString: string,
111
+ ): SafeParseResult<GatesApiActionsRequestCancelSecurity, SDKValidationError> {
112
+ return safeParse(
113
+ jsonString,
114
+ (x) =>
115
+ GatesApiActionsRequestCancelSecurity$inboundSchema.parse(JSON.parse(x)),
116
+ `Failed to parse 'GatesApiActionsRequestCancelSecurity' from JSON`,
117
+ );
118
+ }
119
+
120
+ /** @internal */
121
+ export const GatesApiActionsRequestCancelRequest$inboundSchema: z.ZodType<
122
+ GatesApiActionsRequestCancelRequest,
123
+ z.ZodTypeDef,
124
+ unknown
125
+ > = z.object({
126
+ request_id: types.string(),
127
+ agent: types.string(),
128
+ reason: types.optional(types.string()),
129
+ }).transform((v) => {
130
+ return remap$(v, {
131
+ "request_id": "requestId",
132
+ });
133
+ });
134
+ /** @internal */
135
+ export type GatesApiActionsRequestCancelRequest$Outbound = {
136
+ request_id: string;
137
+ agent: string;
138
+ reason?: string | undefined;
139
+ };
140
+
141
+ /** @internal */
142
+ export const GatesApiActionsRequestCancelRequest$outboundSchema: z.ZodType<
143
+ GatesApiActionsRequestCancelRequest$Outbound,
144
+ z.ZodTypeDef,
145
+ GatesApiActionsRequestCancelRequest
146
+ > = z.object({
147
+ requestId: z.string(),
148
+ agent: z.string(),
149
+ reason: z.string().optional(),
150
+ }).transform((v) => {
151
+ return remap$(v, {
152
+ requestId: "request_id",
153
+ });
154
+ });
155
+
156
+ export function gatesApiActionsRequestCancelRequestToJSON(
157
+ gatesApiActionsRequestCancelRequest: GatesApiActionsRequestCancelRequest,
158
+ ): string {
159
+ return JSON.stringify(
160
+ GatesApiActionsRequestCancelRequest$outboundSchema.parse(
161
+ gatesApiActionsRequestCancelRequest,
162
+ ),
163
+ );
164
+ }
165
+ export function gatesApiActionsRequestCancelRequestFromJSON(
166
+ jsonString: string,
167
+ ): SafeParseResult<GatesApiActionsRequestCancelRequest, SDKValidationError> {
168
+ return safeParse(
169
+ jsonString,
170
+ (x) =>
171
+ GatesApiActionsRequestCancelRequest$inboundSchema.parse(JSON.parse(x)),
172
+ `Failed to parse 'GatesApiActionsRequestCancelRequest' from JSON`,
173
+ );
174
+ }
175
+
176
+ /** @internal */
177
+ export const GatesApiActionsRequestCancelStatus$inboundSchema: z.ZodType<
178
+ GatesApiActionsRequestCancelStatus,
179
+ z.ZodTypeDef,
180
+ unknown
181
+ > = openEnums.inboundSchema(GatesApiActionsRequestCancelStatus);
182
+ /** @internal */
183
+ export const GatesApiActionsRequestCancelStatus$outboundSchema: z.ZodType<
184
+ string,
185
+ z.ZodTypeDef,
186
+ GatesApiActionsRequestCancelStatus
187
+ > = openEnums.outboundSchema(GatesApiActionsRequestCancelStatus);
188
+
189
+ /** @internal */
190
+ export const GatesApiActionsRequestCancelDataData$inboundSchema: z.ZodType<
191
+ GatesApiActionsRequestCancelDataData,
192
+ z.ZodTypeDef,
193
+ unknown
194
+ > = z.object({
195
+ request_id: types.string(),
196
+ status: GatesApiActionsRequestCancelStatus$inboundSchema,
197
+ already_resolved: types.optional(types.boolean()),
198
+ cancelled_at: types.optional(types.date()),
199
+ }).transform((v) => {
200
+ return remap$(v, {
201
+ "request_id": "requestId",
202
+ "already_resolved": "alreadyResolved",
203
+ "cancelled_at": "cancelledAt",
204
+ });
205
+ });
206
+ /** @internal */
207
+ export type GatesApiActionsRequestCancelDataData$Outbound = {
208
+ request_id: string;
209
+ status: string;
210
+ already_resolved?: boolean | undefined;
211
+ cancelled_at?: string | undefined;
212
+ };
213
+
214
+ /** @internal */
215
+ export const GatesApiActionsRequestCancelDataData$outboundSchema: z.ZodType<
216
+ GatesApiActionsRequestCancelDataData$Outbound,
217
+ z.ZodTypeDef,
218
+ GatesApiActionsRequestCancelDataData
219
+ > = z.object({
220
+ requestId: z.string(),
221
+ status: GatesApiActionsRequestCancelStatus$outboundSchema,
222
+ alreadyResolved: z.boolean().optional(),
223
+ cancelledAt: z.date().transform(v => v.toISOString()).optional(),
224
+ }).transform((v) => {
225
+ return remap$(v, {
226
+ requestId: "request_id",
227
+ alreadyResolved: "already_resolved",
228
+ cancelledAt: "cancelled_at",
229
+ });
230
+ });
231
+
232
+ export function gatesApiActionsRequestCancelDataDataToJSON(
233
+ gatesApiActionsRequestCancelDataData: GatesApiActionsRequestCancelDataData,
234
+ ): string {
235
+ return JSON.stringify(
236
+ GatesApiActionsRequestCancelDataData$outboundSchema.parse(
237
+ gatesApiActionsRequestCancelDataData,
238
+ ),
239
+ );
240
+ }
241
+ export function gatesApiActionsRequestCancelDataDataFromJSON(
242
+ jsonString: string,
243
+ ): SafeParseResult<GatesApiActionsRequestCancelDataData, SDKValidationError> {
244
+ return safeParse(
245
+ jsonString,
246
+ (x) =>
247
+ GatesApiActionsRequestCancelDataData$inboundSchema.parse(JSON.parse(x)),
248
+ `Failed to parse 'GatesApiActionsRequestCancelDataData' from JSON`,
249
+ );
250
+ }
251
+
252
+ /** @internal */
253
+ export const GatesApiActionsRequestCancelData$inboundSchema: z.ZodType<
254
+ GatesApiActionsRequestCancelData,
255
+ z.ZodTypeDef,
256
+ unknown
257
+ > = z.object({
258
+ data: types.optional(
259
+ z.lazy(() => GatesApiActionsRequestCancelDataData$inboundSchema),
260
+ ),
261
+ error: types.optional(models.GatesApiError$inboundSchema),
262
+ });
263
+ /** @internal */
264
+ export type GatesApiActionsRequestCancelData$Outbound = {
265
+ data?: GatesApiActionsRequestCancelDataData$Outbound | undefined;
266
+ error?: models.GatesApiError$Outbound | undefined;
267
+ };
268
+
269
+ /** @internal */
270
+ export const GatesApiActionsRequestCancelData$outboundSchema: z.ZodType<
271
+ GatesApiActionsRequestCancelData$Outbound,
272
+ z.ZodTypeDef,
273
+ GatesApiActionsRequestCancelData
274
+ > = z.object({
275
+ data: z.lazy(() => GatesApiActionsRequestCancelDataData$outboundSchema)
276
+ .optional(),
277
+ error: models.GatesApiError$outboundSchema.optional(),
278
+ });
279
+
280
+ export function gatesApiActionsRequestCancelDataToJSON(
281
+ gatesApiActionsRequestCancelData: GatesApiActionsRequestCancelData,
282
+ ): string {
283
+ return JSON.stringify(
284
+ GatesApiActionsRequestCancelData$outboundSchema.parse(
285
+ gatesApiActionsRequestCancelData,
286
+ ),
287
+ );
288
+ }
289
+ export function gatesApiActionsRequestCancelDataFromJSON(
290
+ jsonString: string,
291
+ ): SafeParseResult<GatesApiActionsRequestCancelData, SDKValidationError> {
292
+ return safeParse(
293
+ jsonString,
294
+ (x) => GatesApiActionsRequestCancelData$inboundSchema.parse(JSON.parse(x)),
295
+ `Failed to parse 'GatesApiActionsRequestCancelData' from JSON`,
296
+ );
297
+ }
298
+
299
+ /** @internal */
300
+ export const GatesApiActionsRequestCancelResponse$inboundSchema: z.ZodType<
301
+ GatesApiActionsRequestCancelResponse,
302
+ z.ZodTypeDef,
303
+ unknown
304
+ > = z.object({
305
+ data: z.lazy(() => GatesApiActionsRequestCancelData$inboundSchema),
306
+ });
307
+ /** @internal */
308
+ export type GatesApiActionsRequestCancelResponse$Outbound = {
309
+ data: GatesApiActionsRequestCancelData$Outbound;
310
+ };
311
+
312
+ /** @internal */
313
+ export const GatesApiActionsRequestCancelResponse$outboundSchema: z.ZodType<
314
+ GatesApiActionsRequestCancelResponse$Outbound,
315
+ z.ZodTypeDef,
316
+ GatesApiActionsRequestCancelResponse
317
+ > = z.object({
318
+ data: z.lazy(() => GatesApiActionsRequestCancelData$outboundSchema),
319
+ });
320
+
321
+ export function gatesApiActionsRequestCancelResponseToJSON(
322
+ gatesApiActionsRequestCancelResponse: GatesApiActionsRequestCancelResponse,
323
+ ): string {
324
+ return JSON.stringify(
325
+ GatesApiActionsRequestCancelResponse$outboundSchema.parse(
326
+ gatesApiActionsRequestCancelResponse,
327
+ ),
328
+ );
329
+ }
330
+ export function gatesApiActionsRequestCancelResponseFromJSON(
331
+ jsonString: string,
332
+ ): SafeParseResult<GatesApiActionsRequestCancelResponse, SDKValidationError> {
333
+ return safeParse(
334
+ jsonString,
335
+ (x) =>
336
+ GatesApiActionsRequestCancelResponse$inboundSchema.parse(JSON.parse(x)),
337
+ `Failed to parse 'GatesApiActionsRequestCancelResponse' from JSON`,
338
+ );
339
+ }
@@ -18,6 +18,10 @@ export type GatesApiActionsRequestStatusSecurity = {
18
18
 
19
19
  export type GatesApiActionsRequestStatusRequest = {
20
20
  requestId: string;
21
+ /**
22
+ * The agent you sent the request through. A request is keyed on (agent, request_id); name the agent so the answer is that request's.
23
+ */
24
+ agent?: string | undefined;
21
25
  waitSeconds?: number | undefined;
22
26
  };
23
27
 
@@ -37,11 +41,17 @@ export type GatesApiActionsRequestStatusDataData = {
37
41
  status: GatesApiActionsRequestStatusStatus;
38
42
  act: string;
39
43
  expiresAt: Date;
44
+ /**
45
+ * When the person answered; null while queued.
46
+ */
40
47
  resolvedAt?: Date | null | undefined;
41
48
  /**
42
49
  * Present once approved, until the collection window closes.
43
50
  */
44
51
  token?: string | null | undefined;
52
+ /**
53
+ * Seconds left to collect `token`; 0 once the collection window has closed (then `token` is null).
54
+ */
45
55
  tokenExpiresIn?: number | undefined;
46
56
  };
47
57
 
@@ -54,7 +64,7 @@ export type GatesApiActionsRequestStatusData = {
54
64
  };
55
65
 
56
66
  /**
57
- * The request. Errors as data.error — codes: `invalid_key`, `gates_scope_required`, `request_not_found` (404).
67
+ * The request. Errors as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `org_not_found` (404), `request_not_found` (404).
58
68
  */
59
69
  export type GatesApiActionsRequestStatusResponse = {
60
70
  data: GatesApiActionsRequestStatusData;
@@ -117,6 +127,7 @@ export const GatesApiActionsRequestStatusRequest$inboundSchema: z.ZodType<
117
127
  unknown
118
128
  > = z.object({
119
129
  request_id: types.string(),
130
+ agent: types.optional(types.string()),
120
131
  wait_seconds: types.optional(types.number()),
121
132
  }).transform((v) => {
122
133
  return remap$(v, {
@@ -127,6 +138,7 @@ export const GatesApiActionsRequestStatusRequest$inboundSchema: z.ZodType<
127
138
  /** @internal */
128
139
  export type GatesApiActionsRequestStatusRequest$Outbound = {
129
140
  request_id: string;
141
+ agent?: string | undefined;
130
142
  wait_seconds?: number | undefined;
131
143
  };
132
144
 
@@ -137,6 +149,7 @@ export const GatesApiActionsRequestStatusRequest$outboundSchema: z.ZodType<
137
149
  GatesApiActionsRequestStatusRequest
138
150
  > = z.object({
139
151
  requestId: z.string(),
152
+ agent: z.string().optional(),
140
153
  waitSeconds: z.number().int().optional(),
141
154
  }).transform((v) => {
142
155
  return remap$(v, {
@@ -16,6 +16,11 @@ export type GatesApiActionsRequestSecurity = {
16
16
  gatesKeyAuth: string;
17
17
  };
18
18
 
19
+ export type GatesApiActionsRequestDetail = {
20
+ label: string;
21
+ value: string;
22
+ };
23
+
19
24
  export type GatesApiActionsRequestRequest = {
20
25
  /**
21
26
  * Your idempotency key for this request.
@@ -34,13 +39,21 @@ export type GatesApiActionsRequestRequest = {
34
39
  */
35
40
  actLabel?: string | undefined;
36
41
  /**
37
- * Your reference for the person (the one you linked them with). The person must already be linked.
42
+ * Your reference for the person (the one you linked them with). The person must already be linked. Exactly one of this and `phone_number`.
38
43
  */
39
- partnerUserRef: string;
44
+ partnerUserRef?: string | undefined;
45
+ /**
46
+ * 4.0 · the person's phone number, in place of `partner_user_ref` (exactly one of the two). Used for one lookup, then dropped: never stored, logged or sent in a webhook. The answer is the same whether or not anyone holds the number. Show the returned `match_number` to the person; they pick it in the app before approving. A person not yet linked to your company gets an introduction first, never the card; the ask is held and becomes the card if they allow. An ask nobody answers reads `queued`, then `expired`. Production needs a verified business.
47
+ */
48
+ phoneNumber?: string | undefined;
40
49
  /**
41
50
  * Display only: who asked on the person's behalf, e.g. their assistant.
42
51
  */
43
52
  requestedBy?: string | undefined;
53
+ /**
54
+ * The terms the person is approving, as rows on the card. Shown as you send them and signed with the act: a row changed after the approval breaks it. A label and a value only.
55
+ */
56
+ details?: Array<GatesApiActionsRequestDetail> | undefined;
44
57
  /**
45
58
  * How long the card waits for the person.
46
59
  */
@@ -62,6 +75,10 @@ export type GatesApiActionsRequestDataData = {
62
75
  requestId: string;
63
76
  status: GatesApiActionsRequestStatus;
64
77
  expiresAt: Date;
78
+ /**
79
+ * By phone number only: the two-digit number to show the person (in your conversation, or on your screen). They pick it in the BotShield app before approving.
80
+ */
81
+ matchNumber?: number | undefined;
65
82
  };
66
83
 
67
84
  export type GatesApiActionsRequestData = {
@@ -73,7 +90,7 @@ export type GatesApiActionsRequestData = {
73
90
  };
74
91
 
75
92
  /**
76
- * Queued. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `action_invalid` (400), `action_not_found` (404), `action_off` (404), `agent_not_found` (404), `not_linked` (409 — the person isn't linked to your company), `request_id_reused` (409).
93
+ * Queued. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `org_not_found` (404), `action_invalid` (400), `action_not_found` (404), `action_off` (404), `agent_not_found` (404), `not_linked` (409 — the person isn't linked to your company), `details_invalid` (400), `agent_removed_by_person` (409 — the person removed this agent), `account_reconfirm_required` (409 — the customer changed their phone number without approval from another phone, so they must confirm this account with BotShield again from your signed-in page before anything can be sent to them; nothing is counted or sent), `request_id_reused` (409 — also when the same request_id is sent with other terms), `too_many_open_requests` (429 — this person already has 5 of your requests waiting; carries `retry_after_seconds`), `daily_request_limit` (429 — 50 requests to this person in 24 hours; carries `retry_after_seconds`), `request_limit_unavailable` (503 — the request could not be counted, so it was not sent; retry), `one_addressee_required` (400 — send exactly one of partner_user_ref and phone_number), `phone_invalid` (400), `org_not_verified` (403 — by phone number in production), `send_rate_limited` (429 — asks by phone number per key per hour), `unanswered_limit_reached` (429 — too many unanswered asks by phone number in 24 hours), `unavailable` (503), `internal` (500).
77
94
  */
78
95
  export type GatesApiActionsRequestResponse = {
79
96
  data: GatesApiActionsRequestData;
@@ -128,6 +145,50 @@ export function gatesApiActionsRequestSecurityFromJSON(
128
145
  );
129
146
  }
130
147
 
148
+ /** @internal */
149
+ export const GatesApiActionsRequestDetail$inboundSchema: z.ZodType<
150
+ GatesApiActionsRequestDetail,
151
+ z.ZodTypeDef,
152
+ unknown
153
+ > = z.object({
154
+ label: types.string(),
155
+ value: types.string(),
156
+ });
157
+ /** @internal */
158
+ export type GatesApiActionsRequestDetail$Outbound = {
159
+ label: string;
160
+ value: string;
161
+ };
162
+
163
+ /** @internal */
164
+ export const GatesApiActionsRequestDetail$outboundSchema: z.ZodType<
165
+ GatesApiActionsRequestDetail$Outbound,
166
+ z.ZodTypeDef,
167
+ GatesApiActionsRequestDetail
168
+ > = z.object({
169
+ label: z.string(),
170
+ value: z.string(),
171
+ });
172
+
173
+ export function gatesApiActionsRequestDetailToJSON(
174
+ gatesApiActionsRequestDetail: GatesApiActionsRequestDetail,
175
+ ): string {
176
+ return JSON.stringify(
177
+ GatesApiActionsRequestDetail$outboundSchema.parse(
178
+ gatesApiActionsRequestDetail,
179
+ ),
180
+ );
181
+ }
182
+ export function gatesApiActionsRequestDetailFromJSON(
183
+ jsonString: string,
184
+ ): SafeParseResult<GatesApiActionsRequestDetail, SDKValidationError> {
185
+ return safeParse(
186
+ jsonString,
187
+ (x) => GatesApiActionsRequestDetail$inboundSchema.parse(JSON.parse(x)),
188
+ `Failed to parse 'GatesApiActionsRequestDetail' from JSON`,
189
+ );
190
+ }
191
+
131
192
  /** @internal */
132
193
  export const GatesApiActionsRequestRequest$inboundSchema: z.ZodType<
133
194
  GatesApiActionsRequestRequest,
@@ -138,14 +199,19 @@ export const GatesApiActionsRequestRequest$inboundSchema: z.ZodType<
138
199
  agent: types.string(),
139
200
  act: types.string(),
140
201
  act_label: types.optional(types.string()),
141
- partner_user_ref: types.string(),
202
+ partner_user_ref: types.optional(types.string()),
203
+ phone_number: types.optional(types.string()),
142
204
  requested_by: types.optional(types.string()),
205
+ details: types.optional(
206
+ z.array(z.lazy(() => GatesApiActionsRequestDetail$inboundSchema)),
207
+ ),
143
208
  ttl_seconds: types.number().default(600),
144
209
  }).transform((v) => {
145
210
  return remap$(v, {
146
211
  "request_id": "requestId",
147
212
  "act_label": "actLabel",
148
213
  "partner_user_ref": "partnerUserRef",
214
+ "phone_number": "phoneNumber",
149
215
  "requested_by": "requestedBy",
150
216
  "ttl_seconds": "ttlSeconds",
151
217
  });
@@ -156,8 +222,10 @@ export type GatesApiActionsRequestRequest$Outbound = {
156
222
  agent: string;
157
223
  act: string;
158
224
  act_label?: string | undefined;
159
- partner_user_ref: string;
225
+ partner_user_ref?: string | undefined;
226
+ phone_number?: string | undefined;
160
227
  requested_by?: string | undefined;
228
+ details?: Array<GatesApiActionsRequestDetail$Outbound> | undefined;
161
229
  ttl_seconds: number;
162
230
  };
163
231
 
@@ -171,14 +239,18 @@ export const GatesApiActionsRequestRequest$outboundSchema: z.ZodType<
171
239
  agent: z.string(),
172
240
  act: z.string(),
173
241
  actLabel: z.string().optional(),
174
- partnerUserRef: z.string(),
242
+ partnerUserRef: z.string().optional(),
243
+ phoneNumber: z.string().optional(),
175
244
  requestedBy: z.string().optional(),
245
+ details: z.array(z.lazy(() => GatesApiActionsRequestDetail$outboundSchema))
246
+ .optional(),
176
247
  ttlSeconds: z.number().int().default(600),
177
248
  }).transform((v) => {
178
249
  return remap$(v, {
179
250
  requestId: "request_id",
180
251
  actLabel: "act_label",
181
252
  partnerUserRef: "partner_user_ref",
253
+ phoneNumber: "phone_number",
182
254
  requestedBy: "requested_by",
183
255
  ttlSeconds: "ttl_seconds",
184
256
  });
@@ -225,10 +297,12 @@ export const GatesApiActionsRequestDataData$inboundSchema: z.ZodType<
225
297
  request_id: types.string(),
226
298
  status: GatesApiActionsRequestStatus$inboundSchema,
227
299
  expires_at: types.date(),
300
+ match_number: types.optional(types.number()),
228
301
  }).transform((v) => {
229
302
  return remap$(v, {
230
303
  "request_id": "requestId",
231
304
  "expires_at": "expiresAt",
305
+ "match_number": "matchNumber",
232
306
  });
233
307
  });
234
308
  /** @internal */
@@ -236,6 +310,7 @@ export type GatesApiActionsRequestDataData$Outbound = {
236
310
  request_id: string;
237
311
  status: string;
238
312
  expires_at: string;
313
+ match_number?: number | undefined;
239
314
  };
240
315
 
241
316
  /** @internal */
@@ -247,10 +322,12 @@ export const GatesApiActionsRequestDataData$outboundSchema: z.ZodType<
247
322
  requestId: z.string(),
248
323
  status: GatesApiActionsRequestStatus$outboundSchema,
249
324
  expiresAt: z.date().transform(v => v.toISOString()),
325
+ matchNumber: z.number().int().optional(),
250
326
  }).transform((v) => {
251
327
  return remap$(v, {
252
328
  requestId: "request_id",
253
329
  expiresAt: "expires_at",
330
+ matchNumber: "match_number",
254
331
  });
255
332
  });
256
333
 
@@ -47,7 +47,7 @@ export type GatesApiActionsSetStateData = {
47
47
  };
48
48
 
49
49
  /**
50
- * The action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_not_found` (404), `internal` (500).
50
+ * The action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_not_found` (404), `internal` (500). Each action carries `staff_can_send`.
51
51
  */
52
52
  export type GatesApiActionsSetStateResponse = {
53
53
  data: GatesApiActionsSetStateData;