botshield-sdk 2.3.0 → 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 (313) hide show
  1. package/README.md +14 -2
  2. package/bin/mcp-server.js +753 -47
  3. package/bin/mcp-server.js.map +30 -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/verification-get-status.d.ts +1 -1
  37. package/dist/commonjs/funcs/verification-get-status.js +1 -1
  38. package/dist/commonjs/lib/config.d.ts +2 -2
  39. package/dist/commonjs/lib/config.js +2 -2
  40. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  41. package/dist/commonjs/mcp-server/server.js +1 -1
  42. package/dist/commonjs/models/bot-shield-action.d.ts +10 -0
  43. package/dist/commonjs/models/bot-shield-action.d.ts.map +1 -1
  44. package/dist/commonjs/models/bot-shield-action.js +8 -0
  45. package/dist/commonjs/models/bot-shield-action.js.map +1 -1
  46. package/dist/commonjs/models/error-body.d.ts +6 -1
  47. package/dist/commonjs/models/error-body.d.ts.map +1 -1
  48. package/dist/commonjs/models/error-body.js +4 -0
  49. package/dist/commonjs/models/error-body.js.map +1 -1
  50. package/dist/commonjs/models/gate-unavailable-event.d.ts +112 -0
  51. package/dist/commonjs/models/gate-unavailable-event.d.ts.map +1 -0
  52. package/dist/commonjs/models/gate-unavailable-event.js +137 -0
  53. package/dist/commonjs/models/gate-unavailable-event.js.map +1 -0
  54. package/dist/commonjs/models/gates-api-error.d.ts +5 -0
  55. package/dist/commonjs/models/gates-api-error.d.ts.map +1 -1
  56. package/dist/commonjs/models/gates-api-error.js +11 -0
  57. package/dist/commonjs/models/gates-api-error.js.map +1 -1
  58. package/dist/commonjs/models/index.d.ts +1 -0
  59. package/dist/commonjs/models/index.d.ts.map +1 -1
  60. package/dist/commonjs/models/index.js +1 -0
  61. package/dist/commonjs/models/index.js.map +1 -1
  62. package/dist/commonjs/models/operations/actions-propose.d.ts +21 -1
  63. package/dist/commonjs/models/operations/actions-propose.d.ts.map +1 -1
  64. package/dist/commonjs/models/operations/actions-propose.js +16 -0
  65. package/dist/commonjs/models/operations/actions-propose.js.map +1 -1
  66. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +11 -1
  67. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts.map +1 -1
  68. package/dist/commonjs/models/operations/gates-api-actions-create.js +4 -0
  69. package/dist/commonjs/models/operations/gates-api-actions-create.js.map +1 -1
  70. package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
  71. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  72. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  73. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js +178 -0
  74. package/dist/commonjs/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  75. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts +5 -0
  76. package/dist/commonjs/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  77. package/dist/commonjs/models/operations/gates-api-actions-request-status.js +2 -0
  78. package/dist/commonjs/models/operations/gates-api-actions-request-status.js.map +1 -1
  79. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +34 -4
  80. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts.map +1 -1
  81. package/dist/commonjs/models/operations/gates-api-actions-request.js +32 -3
  82. package/dist/commonjs/models/operations/gates-api-actions-request.js.map +1 -1
  83. package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
  84. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +99 -0
  85. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts.map +1 -0
  86. package/dist/commonjs/models/operations/gates-api-actions-update.js +141 -0
  87. package/dist/commonjs/models/operations/gates-api-actions-update.js.map +1 -0
  88. package/dist/commonjs/models/operations/index.d.ts +5 -0
  89. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  90. package/dist/commonjs/models/operations/index.js +5 -0
  91. package/dist/commonjs/models/operations/index.js.map +1 -1
  92. package/dist/commonjs/models/operations/request-passkey-complete.d.ts +1 -1
  93. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts +130 -0
  94. package/dist/commonjs/models/operations/sdk-confirm-link.d.ts.map +1 -0
  95. package/dist/commonjs/models/operations/sdk-confirm-link.js +205 -0
  96. package/dist/commonjs/models/operations/sdk-confirm-link.js.map +1 -0
  97. package/dist/commonjs/models/operations/sdk-create-session.d.ts +1 -1
  98. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +43 -2
  99. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  100. package/dist/commonjs/models/operations/sdk-create-verification-link.js +30 -1
  101. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  102. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +124 -0
  103. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts.map +1 -0
  104. package/dist/commonjs/models/operations/sdk-send-by-number.js +203 -0
  105. package/dist/commonjs/models/operations/sdk-send-by-number.js.map +1 -0
  106. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts +125 -0
  107. package/dist/commonjs/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  108. package/dist/commonjs/models/operations/sdk-verify-resolution.js +182 -0
  109. package/dist/commonjs/models/operations/sdk-verify-resolution.js.map +1 -0
  110. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +95 -1
  111. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  112. package/dist/commonjs/models/operations/sdk-verify-token.js +86 -1
  113. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  114. package/dist/commonjs/models/operations/verification-get-status.d.ts +40 -5
  115. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  116. package/dist/commonjs/models/operations/verification-get-status.js +33 -2
  117. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  118. package/dist/commonjs/models/passes-per-person.d.ts +1 -1
  119. package/dist/commonjs/sdk/actions.d.ts +8 -1
  120. package/dist/commonjs/sdk/actions.d.ts.map +1 -1
  121. package/dist/commonjs/sdk/actions.js +11 -1
  122. package/dist/commonjs/sdk/actions.js.map +1 -1
  123. package/dist/commonjs/sdk/census.d.ts +17 -1
  124. package/dist/commonjs/sdk/census.d.ts.map +1 -1
  125. package/dist/commonjs/sdk/census.js +23 -1
  126. package/dist/commonjs/sdk/census.js.map +1 -1
  127. package/dist/commonjs/sdk/gates-actions.d.ts +15 -1
  128. package/dist/commonjs/sdk/gates-actions.d.ts.map +1 -1
  129. package/dist/commonjs/sdk/gates-actions.js +21 -1
  130. package/dist/commonjs/sdk/gates-actions.js.map +1 -1
  131. package/dist/commonjs/sdk/sdk.d.ts +2 -2
  132. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  133. package/dist/commonjs/sdk/sdk.js +4 -4
  134. package/dist/commonjs/sdk/sdk.js.map +1 -1
  135. package/dist/commonjs/sdk/verification.d.ts +1 -1
  136. package/dist/commonjs/sdk/verification.js +1 -1
  137. package/dist/esm/funcs/actions-propose-action.d.ts +1 -1
  138. package/dist/esm/funcs/actions-propose-action.js +1 -1
  139. package/dist/esm/funcs/actions-verify-resolution.d.ts +18 -0
  140. package/dist/esm/funcs/actions-verify-resolution.d.ts.map +1 -0
  141. package/dist/esm/funcs/actions-verify-resolution.js +93 -0
  142. package/dist/esm/funcs/actions-verify-resolution.js.map +1 -0
  143. package/dist/esm/funcs/census-confirm-link.d.ts +17 -0
  144. package/dist/esm/funcs/census-confirm-link.d.ts.map +1 -0
  145. package/dist/esm/funcs/census-confirm-link.js +83 -0
  146. package/dist/esm/funcs/census-confirm-link.js.map +1 -0
  147. package/dist/esm/funcs/census-create-verification-link.d.ts +2 -0
  148. package/dist/esm/funcs/census-create-verification-link.d.ts.map +1 -1
  149. package/dist/esm/funcs/census-create-verification-link.js +2 -0
  150. package/dist/esm/funcs/census-create-verification-link.js.map +1 -1
  151. package/dist/esm/funcs/census-send-by-number.d.ts +18 -0
  152. package/dist/esm/funcs/census-send-by-number.d.ts.map +1 -0
  153. package/dist/esm/funcs/census-send-by-number.js +87 -0
  154. package/dist/esm/funcs/census-send-by-number.js.map +1 -0
  155. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  156. package/dist/esm/funcs/census-verify-token.js +1 -1
  157. package/dist/esm/funcs/gates-actions-request-cancel.d.ts +18 -0
  158. package/dist/esm/funcs/gates-actions-request-cancel.d.ts.map +1 -0
  159. package/dist/esm/funcs/gates-actions-request-cancel.js +87 -0
  160. package/dist/esm/funcs/gates-actions-request-cancel.js.map +1 -0
  161. package/dist/esm/funcs/gates-actions-request-status.js +1 -0
  162. package/dist/esm/funcs/gates-actions-request-status.js.map +1 -1
  163. package/dist/esm/funcs/gates-actions-request.d.ts +1 -1
  164. package/dist/esm/funcs/gates-actions-request.js +1 -1
  165. package/dist/esm/funcs/gates-actions-update.d.ts +18 -0
  166. package/dist/esm/funcs/gates-actions-update.d.ts.map +1 -0
  167. package/dist/esm/funcs/gates-actions-update.js +87 -0
  168. package/dist/esm/funcs/gates-actions-update.js.map +1 -0
  169. package/dist/esm/funcs/verification-get-status.d.ts +1 -1
  170. package/dist/esm/funcs/verification-get-status.js +1 -1
  171. package/dist/esm/lib/config.d.ts +2 -2
  172. package/dist/esm/lib/config.js +2 -2
  173. package/dist/esm/mcp-server/mcp-server.js +1 -1
  174. package/dist/esm/mcp-server/server.js +1 -1
  175. package/dist/esm/models/bot-shield-action.d.ts +10 -0
  176. package/dist/esm/models/bot-shield-action.d.ts.map +1 -1
  177. package/dist/esm/models/bot-shield-action.js +8 -0
  178. package/dist/esm/models/bot-shield-action.js.map +1 -1
  179. package/dist/esm/models/error-body.d.ts +6 -1
  180. package/dist/esm/models/error-body.d.ts.map +1 -1
  181. package/dist/esm/models/error-body.js +4 -0
  182. package/dist/esm/models/error-body.js.map +1 -1
  183. package/dist/esm/models/gate-unavailable-event.d.ts +112 -0
  184. package/dist/esm/models/gate-unavailable-event.d.ts.map +1 -0
  185. package/dist/esm/models/gate-unavailable-event.js +99 -0
  186. package/dist/esm/models/gate-unavailable-event.js.map +1 -0
  187. package/dist/esm/models/gates-api-error.d.ts +5 -0
  188. package/dist/esm/models/gates-api-error.d.ts.map +1 -1
  189. package/dist/esm/models/gates-api-error.js +11 -0
  190. package/dist/esm/models/gates-api-error.js.map +1 -1
  191. package/dist/esm/models/index.d.ts +1 -0
  192. package/dist/esm/models/index.d.ts.map +1 -1
  193. package/dist/esm/models/index.js +1 -0
  194. package/dist/esm/models/index.js.map +1 -1
  195. package/dist/esm/models/operations/actions-propose.d.ts +21 -1
  196. package/dist/esm/models/operations/actions-propose.d.ts.map +1 -1
  197. package/dist/esm/models/operations/actions-propose.js +16 -0
  198. package/dist/esm/models/operations/actions-propose.js.map +1 -1
  199. package/dist/esm/models/operations/gates-api-actions-create.d.ts +11 -1
  200. package/dist/esm/models/operations/gates-api-actions-create.d.ts.map +1 -1
  201. package/dist/esm/models/operations/gates-api-actions-create.js +4 -0
  202. package/dist/esm/models/operations/gates-api-actions-create.js.map +1 -1
  203. package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
  204. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts +113 -0
  205. package/dist/esm/models/operations/gates-api-actions-request-cancel.d.ts.map +1 -0
  206. package/dist/esm/models/operations/gates-api-actions-request-cancel.js +132 -0
  207. package/dist/esm/models/operations/gates-api-actions-request-cancel.js.map +1 -0
  208. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts +5 -0
  209. package/dist/esm/models/operations/gates-api-actions-request-status.d.ts.map +1 -1
  210. package/dist/esm/models/operations/gates-api-actions-request-status.js +2 -0
  211. package/dist/esm/models/operations/gates-api-actions-request-status.js.map +1 -1
  212. package/dist/esm/models/operations/gates-api-actions-request.d.ts +34 -4
  213. package/dist/esm/models/operations/gates-api-actions-request.d.ts.map +1 -1
  214. package/dist/esm/models/operations/gates-api-actions-request.js +29 -2
  215. package/dist/esm/models/operations/gates-api-actions-request.js.map +1 -1
  216. package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
  217. package/dist/esm/models/operations/gates-api-actions-update.d.ts +99 -0
  218. package/dist/esm/models/operations/gates-api-actions-update.d.ts.map +1 -0
  219. package/dist/esm/models/operations/gates-api-actions-update.js +95 -0
  220. package/dist/esm/models/operations/gates-api-actions-update.js.map +1 -0
  221. package/dist/esm/models/operations/index.d.ts +5 -0
  222. package/dist/esm/models/operations/index.d.ts.map +1 -1
  223. package/dist/esm/models/operations/index.js +5 -0
  224. package/dist/esm/models/operations/index.js.map +1 -1
  225. package/dist/esm/models/operations/request-passkey-complete.d.ts +1 -1
  226. package/dist/esm/models/operations/sdk-confirm-link.d.ts +130 -0
  227. package/dist/esm/models/operations/sdk-confirm-link.d.ts.map +1 -0
  228. package/dist/esm/models/operations/sdk-confirm-link.js +157 -0
  229. package/dist/esm/models/operations/sdk-confirm-link.js.map +1 -0
  230. package/dist/esm/models/operations/sdk-create-session.d.ts +1 -1
  231. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +43 -2
  232. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  233. package/dist/esm/models/operations/sdk-create-verification-link.js +29 -0
  234. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  235. package/dist/esm/models/operations/sdk-send-by-number.d.ts +124 -0
  236. package/dist/esm/models/operations/sdk-send-by-number.d.ts.map +1 -0
  237. package/dist/esm/models/operations/sdk-send-by-number.js +155 -0
  238. package/dist/esm/models/operations/sdk-send-by-number.js.map +1 -0
  239. package/dist/esm/models/operations/sdk-verify-resolution.d.ts +125 -0
  240. package/dist/esm/models/operations/sdk-verify-resolution.d.ts.map +1 -0
  241. package/dist/esm/models/operations/sdk-verify-resolution.js +136 -0
  242. package/dist/esm/models/operations/sdk-verify-resolution.js.map +1 -0
  243. package/dist/esm/models/operations/sdk-verify-token.d.ts +95 -1
  244. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  245. package/dist/esm/models/operations/sdk-verify-token.js +83 -0
  246. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  247. package/dist/esm/models/operations/verification-get-status.d.ts +40 -5
  248. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  249. package/dist/esm/models/operations/verification-get-status.js +32 -1
  250. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  251. package/dist/esm/models/passes-per-person.d.ts +1 -1
  252. package/dist/esm/sdk/actions.d.ts +8 -1
  253. package/dist/esm/sdk/actions.d.ts.map +1 -1
  254. package/dist/esm/sdk/actions.js +11 -1
  255. package/dist/esm/sdk/actions.js.map +1 -1
  256. package/dist/esm/sdk/census.d.ts +17 -1
  257. package/dist/esm/sdk/census.d.ts.map +1 -1
  258. package/dist/esm/sdk/census.js +23 -1
  259. package/dist/esm/sdk/census.js.map +1 -1
  260. package/dist/esm/sdk/gates-actions.d.ts +15 -1
  261. package/dist/esm/sdk/gates-actions.d.ts.map +1 -1
  262. package/dist/esm/sdk/gates-actions.js +21 -1
  263. package/dist/esm/sdk/gates-actions.js.map +1 -1
  264. package/dist/esm/sdk/sdk.d.ts +2 -2
  265. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  266. package/dist/esm/sdk/sdk.js +4 -4
  267. package/dist/esm/sdk/sdk.js.map +1 -1
  268. package/dist/esm/sdk/verification.d.ts +1 -1
  269. package/dist/esm/sdk/verification.js +1 -1
  270. package/jsr.json +1 -1
  271. package/package.json +1 -1
  272. package/src/funcs/actions-propose-action.ts +1 -1
  273. package/src/funcs/actions-verify-resolution.ts +192 -0
  274. package/src/funcs/census-confirm-link.ts +171 -0
  275. package/src/funcs/census-create-verification-link.ts +2 -0
  276. package/src/funcs/census-send-by-number.ts +180 -0
  277. package/src/funcs/census-verify-token.ts +1 -1
  278. package/src/funcs/gates-actions-request-cancel.ts +187 -0
  279. package/src/funcs/gates-actions-request-status.ts +1 -0
  280. package/src/funcs/gates-actions-request.ts +1 -1
  281. package/src/funcs/gates-actions-update.ts +185 -0
  282. package/src/funcs/verification-get-status.ts +1 -1
  283. package/src/lib/config.ts +2 -2
  284. package/src/mcp-server/mcp-server.ts +1 -1
  285. package/src/mcp-server/server.ts +1 -1
  286. package/src/models/bot-shield-action.ts +18 -0
  287. package/src/models/error-body.ts +10 -1
  288. package/src/models/gate-unavailable-event.ts +218 -0
  289. package/src/models/gates-api-error.ts +16 -0
  290. package/src/models/index.ts +1 -0
  291. package/src/models/operations/actions-propose.ts +37 -1
  292. package/src/models/operations/gates-api-actions-create.ts +15 -1
  293. package/src/models/operations/gates-api-actions-list.ts +1 -1
  294. package/src/models/operations/gates-api-actions-request-cancel.ts +339 -0
  295. package/src/models/operations/gates-api-actions-request-status.ts +7 -0
  296. package/src/models/operations/gates-api-actions-request.ts +83 -6
  297. package/src/models/operations/gates-api-actions-set-state.ts +1 -1
  298. package/src/models/operations/gates-api-actions-update.ts +281 -0
  299. package/src/models/operations/index.ts +5 -0
  300. package/src/models/operations/request-passkey-complete.ts +1 -1
  301. package/src/models/operations/sdk-confirm-link.ts +380 -0
  302. package/src/models/operations/sdk-create-session.ts +1 -1
  303. package/src/models/operations/sdk-create-verification-link.ts +69 -2
  304. package/src/models/operations/sdk-send-by-number.ts +372 -0
  305. package/src/models/operations/sdk-verify-resolution.ts +341 -0
  306. package/src/models/operations/sdk-verify-token.ts +189 -1
  307. package/src/models/operations/verification-get-status.ts +67 -5
  308. package/src/models/passes-per-person.ts +1 -1
  309. package/src/sdk/actions.ts +21 -1
  310. package/src/sdk/census.ts +43 -1
  311. package/src/sdk/gates-actions.ts +41 -1
  312. package/src/sdk/sdk.ts +5 -5
  313. package/src/sdk/verification.ts +1 -1
@@ -3,9 +3,11 @@
3
3
  */
4
4
  import { gatesActionsCreate } from "../funcs/gates-actions-create.js";
5
5
  import { gatesActionsList } from "../funcs/gates-actions-list.js";
6
+ import { gatesActionsRequestCancel } from "../funcs/gates-actions-request-cancel.js";
6
7
  import { gatesActionsRequestStatus } from "../funcs/gates-actions-request-status.js";
7
8
  import { gatesActionsRequest } from "../funcs/gates-actions-request.js";
8
9
  import { gatesActionsSetState } from "../funcs/gates-actions-set-state.js";
10
+ import { gatesActionsUpdate } from "../funcs/gates-actions-update.js";
9
11
  import { ClientSDK } from "../lib/sdks.js";
10
12
  import { unwrapAsync } from "../types/fp.js";
11
13
  export class GatesActions extends ClientSDK {
@@ -36,11 +38,20 @@ export class GatesActions extends ClientSDK {
36
38
  async setState(security, request, options) {
37
39
  return unwrapAsync(gatesActionsSetState(this, security, request, options));
38
40
  }
41
+ /**
42
+ * Rename a BotShield Action, or mark it staff can send
43
+ *
44
+ * @remarks
45
+ * Change an action's `name` (what the person reads on their card) or `staffCanSend` (your support team can send it to a customer), by its key. Send at least one.
46
+ */
47
+ async update(security, request, options) {
48
+ return unwrapAsync(gatesActionsUpdate(this, security, request, options));
49
+ }
39
50
  /**
40
51
  * Ask a linked person to confirm an action
41
52
  *
42
53
  * @remarks
43
- * An agent asks, a person confirms. Puts ONE BotShield Action in front of a person already linked to your company, as a card in their BotShield app naming the agent that asked. The person approves with their passkey, which signs the act itself. Collect the action token with gates-api/actions/request-status and check it with sdk/verify-token (claims.act), exactly as for a tapped action. Idempotent on (agent, request_id).
54
+ * An agent asks, a person confirms. Puts ONE BotShield Action in front of a person already linked to your company, as a card in their BotShield app naming the agent that asked. The person approves with their passkey, which signs the act itself. Collect the action token with gates-api/actions/request-status and check it with sdk/verify-token (claims.act), exactly as for a tapped action. Idempotent on (agent, request_id). Or address the person by `phone_number` (no link needed beforehand; see the field).
44
55
  */
45
56
  async request(security, request, options) {
46
57
  return unwrapAsync(gatesActionsRequest(this, security, request, options));
@@ -54,5 +65,14 @@ export class GatesActions extends ClientSDK {
54
65
  async requestStatus(security, request, options) {
55
66
  return unwrapAsync(gatesActionsRequestStatus(this, security, request, options));
56
67
  }
68
+ /**
69
+ * Withdraw an action request
70
+ *
71
+ * @remarks
72
+ * Withdraws a request you sent with actions/request while it is still waiting for the person. The card leaves their BotShield app. A request that was already answered, expired or withdrawn comes back as it stands with already_resolved true; an approval cannot be undone here. A withdrawn request is not billed.
73
+ */
74
+ async requestCancel(security, request, options) {
75
+ return unwrapAsync(gatesActionsRequestCancel(this, security, request, options));
76
+ }
57
77
  }
58
78
  //# sourceMappingURL=gates-actions.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"gates-actions.js","sourceRoot":"","sources":["../../../src/sdk/gates-actions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,YAAa,SAAQ,SAAS;IACzC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,QAAkD,EAClD,OAAgD,EAChD,OAAwB,EAC2B;QACnD,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,QAAgD,EAChD,OAAwB,EACyB;QACjD,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,QAAQ,EACR,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,QAAoD,EACpD,OAAkD,EAClD,OAAwB,EAC6B;QACrD,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,QAAmD,EACnD,OAAiD,EACjD,OAAwB,EAC4B;QACpD,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,QAAyD,EACzD,OAAuD,EACvD,OAAwB,EACkC;QAC1D,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;CACF"}
1
+ {"version":3,"file":"gates-actions.js","sourceRoot":"","sources":["../../../src/sdk/gates-actions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,YAAa,SAAQ,SAAS;IACzC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,QAAkD,EAClD,OAAgD,EAChD,OAAwB,EAC2B;QACnD,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,QAAgD,EAChD,OAAwB,EACyB;QACjD,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,QAAQ,EACR,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,QAAoD,EACpD,OAAkD,EAClD,OAAwB,EAC6B;QACrD,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,QAAkD,EAClD,OAAgD,EAChD,OAAwB,EAC2B;QACnD,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,QAAmD,EACnD,OAAiD,EACjD,OAAwB,EAC4B;QACpD,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,QAAyD,EACzD,OAAuD,EACvD,OAAwB,EACkC;QAC1D,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,QAAyD,EACzD,OAAuD,EACvD,OAAwB,EACkC;QAC1D,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IAAA,CACJ;CACF"}
@@ -8,10 +8,10 @@ import { Verification } from "./verification.js";
8
8
  export declare class BotShield extends ClientSDK {
9
9
  private _census?;
10
10
  get census(): Census;
11
- private _verification?;
12
- get verification(): Verification;
13
11
  private _actions?;
14
12
  get actions(): Actions;
13
+ private _verification?;
14
+ get verification(): Verification;
15
15
  private _securedAccounts?;
16
16
  get securedAccounts(): SecuredAccounts;
17
17
  private _gates?;
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,qBAAa,SAAU,SAAQ,SAAS;IACtC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;CACF"}
1
+ {"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,qBAAa,SAAU,SAAQ,SAAS;IACtC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;CACF"}
@@ -13,14 +13,14 @@ export class BotShield extends ClientSDK {
13
13
  get census() {
14
14
  return (this._census ?? (this._census = new Census(this._options)));
15
15
  }
16
- _verification;
17
- get verification() {
18
- return (this._verification ?? (this._verification = new Verification(this._options)));
19
- }
20
16
  _actions;
21
17
  get actions() {
22
18
  return (this._actions ?? (this._actions = new Actions(this._options)));
23
19
  }
20
+ _verification;
21
+ get verification() {
22
+ return (this._verification ?? (this._verification = new Verification(this._options)));
23
+ }
24
24
  _securedAccounts;
25
25
  get securedAccounts() {
26
26
  return (this._securedAccounts ?? (this._securedAccounts = new SecuredAccounts(this._options)));
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,OAAO,SAAU,SAAQ,SAAS;IAC9B,OAAO,CAAU;IACzB,IAAI,MAAM,GAAW;QACnB,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACrD;IAEO,aAAa,CAAgB;IACrC,IAAI,YAAY,GAAiB;QAC/B,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACjE;IAEO,QAAQ,CAAW;IAC3B,IAAI,OAAO,GAAY;QACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvD;IAEO,gBAAgB,CAAmB;IAC3C,IAAI,eAAe,GAAoB;QACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvE;IAEO,MAAM,CAAS;IACvB,IAAI,KAAK,GAAU;QACjB,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnD;IAEO,cAAc,CAAiB;IACvC,IAAI,aAAa,GAAkB;QACjC,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnE;CACF"}
1
+ {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,OAAO,SAAU,SAAQ,SAAS;IAC9B,OAAO,CAAU;IACzB,IAAI,MAAM,GAAW;QACnB,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACrD;IAEO,QAAQ,CAAW;IAC3B,IAAI,OAAO,GAAY;QACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvD;IAEO,aAAa,CAAgB;IACrC,IAAI,YAAY,GAAiB;QAC/B,OAAO,CAAC,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACjE;IAEO,gBAAgB,CAAmB;IAC3C,IAAI,eAAe,GAAoB;QACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,KAArB,IAAI,CAAC,gBAAgB,GAAK,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACvE;IAEO,MAAM,CAAS;IACvB,IAAI,KAAK,GAAU;QACjB,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnD;IAEO,cAAc,CAAiB;IACvC,IAAI,aAAa,GAAkB;QACjC,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAAA,CACnE;CACF"}
@@ -5,7 +5,7 @@ export declare class Verification extends ClientSDK {
5
5
  * Check verification status
6
6
  *
7
7
  * @remarks
8
- * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary.
8
+ * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
9
9
  */
10
10
  getStatus(security: operations.VerificationGetStatusSecurity, request: operations.VerificationGetStatusRequest, options?: RequestOptions): Promise<operations.VerificationGetStatusResponse>;
11
11
  }
@@ -9,7 +9,7 @@ export class Verification extends ClientSDK {
9
9
  * Check verification status
10
10
  *
11
11
  * @remarks
12
- * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary.
12
+ * Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
13
13
  */
14
14
  async getStatus(security, request, options) {
15
15
  return unwrapAsync(verificationGetStatus(this, security, request, options));
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "botshield-sdk",
5
- "version": "2.3.0",
5
+ "version": "4.0.0",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "botshield-sdk",
3
- "version": "2.3.0",
3
+ "version": "4.0.0",
4
4
  "author": "BotShield",
5
5
  "description": "Official TypeScript SDK for BotShield — privacy-first human verification (passkeys, no PII) and Agents Ask approvals",
6
6
  "homepage": "https://docs.botshield.ai",
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
30
30
  * Propose an action for human confirmation
31
31
  *
32
32
  * @remarks
33
- * Queue a human-presence-gated action for a BotShield user. The user receives the card in the BotShield app (Agents Ask), confirms or denies with their passkey, and BotShield delivers a signed Proof of Resolution JWT to your registered callback URL (or poll check-status). Identify the user by opaque_id — the pairwise id from the bind ceremony. Authentication: agent key (bs_agent_<name>__<secret>) in the Authorization header.
33
+ * Queue a human-presence-gated action for a BotShield user. The user receives the card in the BotShield app (Agents Ask), confirms or denies with their passkey, and BotShield delivers a signed Proof of Resolution JWT to your registered callback URL (or poll check-status). Identify the user by opaque_id — the pairwise id from the bind ceremony. Authentication: agent key (bs_agent_<name>__<secret>) in the Authorization header. Or address the person by `phone_number` (no link needed beforehand; see the field).
34
34
  */
35
35
  export function actionsProposeAction(
36
36
  client: BotShieldCore,
@@ -0,0 +1,192 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { BotShieldCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { resolveSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import { BotShieldError } from "../models/errors/bot-shield-error.js";
15
+ import {
16
+ ConnectionError,
17
+ InvalidRequestError,
18
+ RequestAbortedError,
19
+ RequestTimeoutError,
20
+ UnexpectedClientError,
21
+ } from "../models/errors/http-client-errors.js";
22
+ import * as errors from "../models/errors/index.js";
23
+ import { ResponseValidationError } from "../models/errors/response-validation-error.js";
24
+ import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
25
+ import * as operations from "../models/operations/index.js";
26
+ import { APICall, APIPromise } from "../types/async.js";
27
+ import { Result } from "../types/fp.js";
28
+
29
+ /**
30
+ * Check a Proof of Resolution (works once)
31
+ *
32
+ * @remarks
33
+ * An approved ask mints a proof that the agent reads with agentlink/check-status. Send it here before acting on it. The first check answers valid true with what was approved; every later check answers valid false with replayed true. Checking the signature yourself against the public keys shows the proof is real, not that it is unused. Call with the agent's own key (for a proof minted for that agent) or the company's secret key (for a proof minted for one of its agents).
34
+ */
35
+ export function actionsVerifyResolution(
36
+ client: BotShieldCore,
37
+ security: operations.SDKVerifyResolutionSecurity,
38
+ request: operations.SDKVerifyResolutionRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.SDKVerifyResolutionResponse,
43
+ | errors.InvalidInputError
44
+ | errors.ErrorResponse
45
+ | BotShieldError
46
+ | ResponseValidationError
47
+ | ConnectionError
48
+ | RequestAbortedError
49
+ | RequestTimeoutError
50
+ | InvalidRequestError
51
+ | UnexpectedClientError
52
+ | SDKValidationError
53
+ >
54
+ > {
55
+ return new APIPromise($do(
56
+ client,
57
+ security,
58
+ request,
59
+ options,
60
+ ));
61
+ }
62
+
63
+ async function $do(
64
+ client: BotShieldCore,
65
+ security: operations.SDKVerifyResolutionSecurity,
66
+ request: operations.SDKVerifyResolutionRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.SDKVerifyResolutionResponse,
72
+ | errors.InvalidInputError
73
+ | errors.ErrorResponse
74
+ | BotShieldError
75
+ | ResponseValidationError
76
+ | ConnectionError
77
+ | RequestAbortedError
78
+ | RequestTimeoutError
79
+ | InvalidRequestError
80
+ | UnexpectedClientError
81
+ | SDKValidationError
82
+ >,
83
+ APICall,
84
+ ]
85
+ > {
86
+ const parsed = safeParse(
87
+ request,
88
+ (value) =>
89
+ operations.SDKVerifyResolutionRequest$outboundSchema.parse(value),
90
+ "Input validation failed",
91
+ );
92
+ if (!parsed.ok) {
93
+ return [parsed, { status: "invalid" }];
94
+ }
95
+ const payload = parsed.value;
96
+ const body = encodeJSON("body", payload, { explode: true });
97
+
98
+ const path = pathToFunc("/sdk/verify-resolution")();
99
+
100
+ const headers = new Headers(compactMap({
101
+ "Content-Type": "application/json",
102
+ Accept: "application/json",
103
+ }));
104
+
105
+ const requestSecurity = resolveSecurity(
106
+ [
107
+ {
108
+ fieldName: "Authorization",
109
+ type: "apiKey:header",
110
+ value: security?.agentKeyAuth,
111
+ },
112
+ ],
113
+ [
114
+ {
115
+ fieldName: "Authorization",
116
+ type: "apiKey:header",
117
+ value: security?.apiKeyAuth,
118
+ },
119
+ ],
120
+ );
121
+
122
+ const context = {
123
+ options: client._options,
124
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
125
+ operationID: "SdkVerifyResolution",
126
+ oAuth2Scopes: null,
127
+
128
+ resolvedSecurity: requestSecurity,
129
+
130
+ securitySource: security,
131
+ retryConfig: options?.retries
132
+ || client._options.retryConfig
133
+ || { strategy: "none" },
134
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
135
+ };
136
+
137
+ const requestRes = client._createRequest(context, {
138
+ security: requestSecurity,
139
+ method: "POST",
140
+ baseURL: options?.serverURL,
141
+ path: path,
142
+ headers: headers,
143
+ body: body,
144
+ userAgent: client._options.userAgent,
145
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
146
+ }, options);
147
+ if (!requestRes.ok) {
148
+ return [requestRes, { status: "invalid" }];
149
+ }
150
+ const req = requestRes.value;
151
+
152
+ const doResult = await client._do(req, {
153
+ context,
154
+ isErrorStatusCode: (statusCode: number) =>
155
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
156
+ retryConfig: context.retryConfig,
157
+ retryCodes: context.retryCodes,
158
+ });
159
+ if (!doResult.ok) {
160
+ return [doResult, { status: "request-error", request: req }];
161
+ }
162
+ const response = doResult.value;
163
+
164
+ const responseFields = {
165
+ HttpMeta: { Response: response, Request: req },
166
+ };
167
+
168
+ const [result] = await M.match<
169
+ operations.SDKVerifyResolutionResponse,
170
+ | errors.InvalidInputError
171
+ | errors.ErrorResponse
172
+ | BotShieldError
173
+ | ResponseValidationError
174
+ | ConnectionError
175
+ | RequestAbortedError
176
+ | RequestTimeoutError
177
+ | InvalidRequestError
178
+ | UnexpectedClientError
179
+ | SDKValidationError
180
+ >(
181
+ M.json(200, operations.SDKVerifyResolutionResponse$inboundSchema),
182
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
183
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
184
+ M.fail("4XX"),
185
+ M.fail("5XX"),
186
+ )(response, req, { extraFields: responseFields });
187
+ if (!result.ok) {
188
+ return [result, { status: "complete", request: req, response }];
189
+ }
190
+
191
+ return [result, { status: "complete", request: req, response }];
192
+ }
@@ -0,0 +1,171 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { BotShieldCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { resolveSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import { BotShieldError } from "../models/errors/bot-shield-error.js";
15
+ import {
16
+ ConnectionError,
17
+ InvalidRequestError,
18
+ RequestAbortedError,
19
+ RequestTimeoutError,
20
+ UnexpectedClientError,
21
+ } from "../models/errors/http-client-errors.js";
22
+ import { ResponseValidationError } from "../models/errors/response-validation-error.js";
23
+ import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
24
+ import * as operations from "../models/operations/index.js";
25
+ import { APICall, APIPromise } from "../types/async.js";
26
+ import { Result } from "../types/fp.js";
27
+
28
+ /**
29
+ * Confirm a pending link
30
+ *
31
+ * @remarks
32
+ * 4.0: on a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
33
+ */
34
+ export function censusConfirmLink(
35
+ client: BotShieldCore,
36
+ security: operations.SDKConfirmLinkSecurity,
37
+ request: operations.SDKConfirmLinkRequest,
38
+ options?: RequestOptions,
39
+ ): APIPromise<
40
+ Result<
41
+ operations.SDKConfirmLinkResponse,
42
+ | BotShieldError
43
+ | ResponseValidationError
44
+ | ConnectionError
45
+ | RequestAbortedError
46
+ | RequestTimeoutError
47
+ | InvalidRequestError
48
+ | UnexpectedClientError
49
+ | SDKValidationError
50
+ >
51
+ > {
52
+ return new APIPromise($do(
53
+ client,
54
+ security,
55
+ request,
56
+ options,
57
+ ));
58
+ }
59
+
60
+ async function $do(
61
+ client: BotShieldCore,
62
+ security: operations.SDKConfirmLinkSecurity,
63
+ request: operations.SDKConfirmLinkRequest,
64
+ options?: RequestOptions,
65
+ ): Promise<
66
+ [
67
+ Result<
68
+ operations.SDKConfirmLinkResponse,
69
+ | BotShieldError
70
+ | ResponseValidationError
71
+ | ConnectionError
72
+ | RequestAbortedError
73
+ | RequestTimeoutError
74
+ | InvalidRequestError
75
+ | UnexpectedClientError
76
+ | SDKValidationError
77
+ >,
78
+ APICall,
79
+ ]
80
+ > {
81
+ const parsed = safeParse(
82
+ request,
83
+ (value) => operations.SDKConfirmLinkRequest$outboundSchema.parse(value),
84
+ "Input validation failed",
85
+ );
86
+ if (!parsed.ok) {
87
+ return [parsed, { status: "invalid" }];
88
+ }
89
+ const payload = parsed.value;
90
+ const body = encodeJSON("body", payload, { explode: true });
91
+
92
+ const path = pathToFunc("/sdk/confirm-link")();
93
+
94
+ const headers = new Headers(compactMap({
95
+ "Content-Type": "application/json",
96
+ Accept: "application/json",
97
+ }));
98
+
99
+ const requestSecurity = resolveSecurity(
100
+ [
101
+ {
102
+ fieldName: "Authorization",
103
+ type: "apiKey:header",
104
+ value: security?.apiKeyAuth,
105
+ },
106
+ ],
107
+ );
108
+
109
+ const context = {
110
+ options: client._options,
111
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
112
+ operationID: "SdkConfirmLink",
113
+ oAuth2Scopes: null,
114
+
115
+ resolvedSecurity: requestSecurity,
116
+
117
+ securitySource: security,
118
+ retryConfig: options?.retries
119
+ || client._options.retryConfig
120
+ || { strategy: "none" },
121
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
122
+ };
123
+
124
+ const requestRes = client._createRequest(context, {
125
+ security: requestSecurity,
126
+ method: "POST",
127
+ baseURL: options?.serverURL,
128
+ path: path,
129
+ headers: headers,
130
+ body: body,
131
+ userAgent: client._options.userAgent,
132
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
133
+ }, options);
134
+ if (!requestRes.ok) {
135
+ return [requestRes, { status: "invalid" }];
136
+ }
137
+ const req = requestRes.value;
138
+
139
+ const doResult = await client._do(req, {
140
+ context,
141
+ isErrorStatusCode: (statusCode: number) =>
142
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
143
+ retryConfig: context.retryConfig,
144
+ retryCodes: context.retryCodes,
145
+ });
146
+ if (!doResult.ok) {
147
+ return [doResult, { status: "request-error", request: req }];
148
+ }
149
+ const response = doResult.value;
150
+
151
+ const [result] = await M.match<
152
+ operations.SDKConfirmLinkResponse,
153
+ | BotShieldError
154
+ | ResponseValidationError
155
+ | ConnectionError
156
+ | RequestAbortedError
157
+ | RequestTimeoutError
158
+ | InvalidRequestError
159
+ | UnexpectedClientError
160
+ | SDKValidationError
161
+ >(
162
+ M.json(200, operations.SDKConfirmLinkResponse$inboundSchema),
163
+ M.fail("4XX"),
164
+ M.fail("5XX"),
165
+ )(response, req);
166
+ if (!result.ok) {
167
+ return [result, { status: "complete", request: req, response }];
168
+ }
169
+
170
+ return [result, { status: "complete", request: req, response }];
171
+ }
@@ -31,6 +31,8 @@ import { Result } from "../types/fp.js";
31
31
  *
32
32
  * @remarks
33
33
  * Creates a verification request (deep link, web URL, QR code) for a gate. Requires an anchor grant token from create-session. Returns 409 when a pending request already exists for the same gate and user.
34
+ *
35
+ * **A check sent to one person** (a request with `partner_user_ref` whose account is linked, pushed to the person's phones): one is open at a time per organization, environment and person. A newer one that is pushed replaces the open one, which ends `cancelled` with reason `superseded` (verification/status) and fires `gate.unavailable` once with `failure_code: "superseded"`. Pushes are capped per person per day (default 5 in 24 hours); over the cap the request is still created and its QR / deep link work, but nothing is pushed (`push_skipped: "daily_cap"`).
34
36
  */
35
37
  export function censusCreateVerificationLink(
36
38
  client: BotShieldCore,