botshield-sdk 4.0.0 → 4.0.3

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 (238) hide show
  1. package/README.md +17 -5
  2. package/bin/mcp-server.js +395 -22
  3. package/bin/mcp-server.js.map +25 -21
  4. package/dist/commonjs/funcs/census-confirm-link.d.ts +1 -1
  5. package/dist/commonjs/funcs/census-confirm-link.js +1 -1
  6. package/dist/commonjs/funcs/census-send-by-number.d.ts +1 -1
  7. package/dist/commonjs/funcs/census-send-by-number.js +1 -1
  8. package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
  9. package/dist/commonjs/funcs/census-verify-token.js +1 -1
  10. package/dist/commonjs/funcs/recovery-exchange.d.ts +18 -0
  11. package/dist/commonjs/funcs/recovery-exchange.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/recovery-exchange.js +123 -0
  13. package/dist/commonjs/funcs/recovery-exchange.js.map +1 -0
  14. package/dist/commonjs/funcs/recovery-other-route.d.ts +18 -0
  15. package/dist/commonjs/funcs/recovery-other-route.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/recovery-other-route.js +123 -0
  17. package/dist/commonjs/funcs/recovery-other-route.js.map +1 -0
  18. package/dist/commonjs/funcs/sign-in-confirm.d.ts +18 -0
  19. package/dist/commonjs/funcs/sign-in-confirm.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/sign-in-confirm.js +123 -0
  21. package/dist/commonjs/funcs/sign-in-confirm.js.map +1 -0
  22. package/dist/commonjs/funcs/sign-in-request.d.ts +18 -0
  23. package/dist/commonjs/funcs/sign-in-request.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/sign-in-request.js +123 -0
  25. package/dist/commonjs/funcs/sign-in-request.js.map +1 -0
  26. package/dist/commonjs/funcs/verification-get-status.d.ts +1 -1
  27. package/dist/commonjs/funcs/verification-get-status.js +2 -1
  28. package/dist/commonjs/funcs/verification-get-status.js.map +1 -1
  29. package/dist/commonjs/lib/config.d.ts +2 -12
  30. package/dist/commonjs/lib/config.d.ts.map +1 -1
  31. package/dist/commonjs/lib/config.js +3 -13
  32. package/dist/commonjs/lib/config.js.map +1 -1
  33. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  34. package/dist/commonjs/mcp-server/server.js +1 -1
  35. package/dist/commonjs/models/bot-shield-action.d.ts +37 -1
  36. package/dist/commonjs/models/bot-shield-action.d.ts.map +1 -1
  37. package/dist/commonjs/models/bot-shield-action.js +28 -1
  38. package/dist/commonjs/models/bot-shield-action.js.map +1 -1
  39. package/dist/commonjs/models/error-body.d.ts +1 -1
  40. package/dist/commonjs/models/operations/actions-propose.d.ts +1 -1
  41. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +2 -2
  42. package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
  43. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +2 -2
  44. package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
  45. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +2 -2
  46. package/dist/commonjs/models/operations/index.d.ts +4 -0
  47. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  48. package/dist/commonjs/models/operations/index.js +4 -0
  49. package/dist/commonjs/models/operations/index.js.map +1 -1
  50. package/dist/commonjs/models/operations/recovery-exchange.d.ts +114 -0
  51. package/dist/commonjs/models/operations/recovery-exchange.d.ts.map +1 -0
  52. package/dist/commonjs/models/operations/recovery-exchange.js +164 -0
  53. package/dist/commonjs/models/operations/recovery-exchange.js.map +1 -0
  54. package/dist/commonjs/models/operations/recovery-other-route.d.ts +86 -0
  55. package/dist/commonjs/models/operations/recovery-other-route.d.ts.map +1 -0
  56. package/dist/commonjs/models/operations/recovery-other-route.js +145 -0
  57. package/dist/commonjs/models/operations/recovery-other-route.js.map +1 -0
  58. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +6 -1
  59. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  60. package/dist/commonjs/models/operations/sdk-create-verification-link.js +4 -0
  61. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  62. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +1 -1
  63. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +19 -4
  64. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  65. package/dist/commonjs/models/operations/sdk-verify-token.js +10 -0
  66. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  67. package/dist/commonjs/models/operations/secured-accounts-list.d.ts +5 -0
  68. package/dist/commonjs/models/operations/secured-accounts-list.d.ts.map +1 -1
  69. package/dist/commonjs/models/operations/secured-accounts-list.js +2 -0
  70. package/dist/commonjs/models/operations/secured-accounts-list.js.map +1 -1
  71. package/dist/commonjs/models/operations/secured-accounts-status.d.ts +5 -0
  72. package/dist/commonjs/models/operations/secured-accounts-status.d.ts.map +1 -1
  73. package/dist/commonjs/models/operations/secured-accounts-status.js +2 -0
  74. package/dist/commonjs/models/operations/secured-accounts-status.js.map +1 -1
  75. package/dist/commonjs/models/operations/signin-confirm.d.ts +148 -0
  76. package/dist/commonjs/models/operations/signin-confirm.d.ts.map +1 -0
  77. package/dist/commonjs/models/operations/signin-confirm.js +202 -0
  78. package/dist/commonjs/models/operations/signin-confirm.js.map +1 -0
  79. package/dist/commonjs/models/operations/signin-request.d.ts +115 -0
  80. package/dist/commonjs/models/operations/signin-request.d.ts.map +1 -0
  81. package/dist/commonjs/models/operations/signin-request.js +174 -0
  82. package/dist/commonjs/models/operations/signin-request.js.map +1 -0
  83. package/dist/commonjs/models/operations/verification-get-status.d.ts +10 -5
  84. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  85. package/dist/commonjs/models/operations/verification-get-status.js +5 -1
  86. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  87. package/dist/commonjs/sdk/census.d.ts +3 -3
  88. package/dist/commonjs/sdk/census.js +3 -3
  89. package/dist/commonjs/sdk/recovery.d.ts +19 -0
  90. package/dist/commonjs/sdk/recovery.d.ts.map +1 -0
  91. package/dist/commonjs/sdk/recovery.js +32 -0
  92. package/dist/commonjs/sdk/recovery.js.map +1 -0
  93. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  94. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  95. package/dist/commonjs/sdk/sdk.js +10 -0
  96. package/dist/commonjs/sdk/sdk.js.map +1 -1
  97. package/dist/commonjs/sdk/sign-in.d.ts +19 -0
  98. package/dist/commonjs/sdk/sign-in.d.ts.map +1 -0
  99. package/dist/commonjs/sdk/sign-in.js +32 -0
  100. package/dist/commonjs/sdk/sign-in.js.map +1 -0
  101. package/dist/commonjs/sdk/verification.d.ts +1 -1
  102. package/dist/commonjs/sdk/verification.js +1 -1
  103. package/dist/esm/funcs/census-confirm-link.d.ts +1 -1
  104. package/dist/esm/funcs/census-confirm-link.js +1 -1
  105. package/dist/esm/funcs/census-send-by-number.d.ts +1 -1
  106. package/dist/esm/funcs/census-send-by-number.js +1 -1
  107. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  108. package/dist/esm/funcs/census-verify-token.js +1 -1
  109. package/dist/esm/funcs/recovery-exchange.d.ts +18 -0
  110. package/dist/esm/funcs/recovery-exchange.d.ts.map +1 -0
  111. package/dist/esm/funcs/recovery-exchange.js +87 -0
  112. package/dist/esm/funcs/recovery-exchange.js.map +1 -0
  113. package/dist/esm/funcs/recovery-other-route.d.ts +18 -0
  114. package/dist/esm/funcs/recovery-other-route.d.ts.map +1 -0
  115. package/dist/esm/funcs/recovery-other-route.js +87 -0
  116. package/dist/esm/funcs/recovery-other-route.js.map +1 -0
  117. package/dist/esm/funcs/sign-in-confirm.d.ts +18 -0
  118. package/dist/esm/funcs/sign-in-confirm.d.ts.map +1 -0
  119. package/dist/esm/funcs/sign-in-confirm.js +87 -0
  120. package/dist/esm/funcs/sign-in-confirm.js.map +1 -0
  121. package/dist/esm/funcs/sign-in-request.d.ts +18 -0
  122. package/dist/esm/funcs/sign-in-request.d.ts.map +1 -0
  123. package/dist/esm/funcs/sign-in-request.js +87 -0
  124. package/dist/esm/funcs/sign-in-request.js.map +1 -0
  125. package/dist/esm/funcs/verification-get-status.d.ts +1 -1
  126. package/dist/esm/funcs/verification-get-status.js +3 -2
  127. package/dist/esm/funcs/verification-get-status.js.map +1 -1
  128. package/dist/esm/lib/config.d.ts +2 -12
  129. package/dist/esm/lib/config.d.ts.map +1 -1
  130. package/dist/esm/lib/config.js +2 -12
  131. package/dist/esm/lib/config.js.map +1 -1
  132. package/dist/esm/mcp-server/mcp-server.js +1 -1
  133. package/dist/esm/mcp-server/server.js +1 -1
  134. package/dist/esm/models/bot-shield-action.d.ts +37 -1
  135. package/dist/esm/models/bot-shield-action.d.ts.map +1 -1
  136. package/dist/esm/models/bot-shield-action.js +27 -0
  137. package/dist/esm/models/bot-shield-action.js.map +1 -1
  138. package/dist/esm/models/error-body.d.ts +1 -1
  139. package/dist/esm/models/operations/actions-propose.d.ts +1 -1
  140. package/dist/esm/models/operations/gates-api-actions-create.d.ts +2 -2
  141. package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
  142. package/dist/esm/models/operations/gates-api-actions-request.d.ts +2 -2
  143. package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
  144. package/dist/esm/models/operations/gates-api-actions-update.d.ts +2 -2
  145. package/dist/esm/models/operations/index.d.ts +4 -0
  146. package/dist/esm/models/operations/index.d.ts.map +1 -1
  147. package/dist/esm/models/operations/index.js +4 -0
  148. package/dist/esm/models/operations/index.js.map +1 -1
  149. package/dist/esm/models/operations/recovery-exchange.d.ts +114 -0
  150. package/dist/esm/models/operations/recovery-exchange.d.ts.map +1 -0
  151. package/dist/esm/models/operations/recovery-exchange.js +118 -0
  152. package/dist/esm/models/operations/recovery-exchange.js.map +1 -0
  153. package/dist/esm/models/operations/recovery-other-route.d.ts +86 -0
  154. package/dist/esm/models/operations/recovery-other-route.d.ts.map +1 -0
  155. package/dist/esm/models/operations/recovery-other-route.js +99 -0
  156. package/dist/esm/models/operations/recovery-other-route.js.map +1 -0
  157. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +6 -1
  158. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  159. package/dist/esm/models/operations/sdk-create-verification-link.js +4 -0
  160. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  161. package/dist/esm/models/operations/sdk-send-by-number.d.ts +1 -1
  162. package/dist/esm/models/operations/sdk-verify-token.d.ts +19 -4
  163. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  164. package/dist/esm/models/operations/sdk-verify-token.js +10 -0
  165. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  166. package/dist/esm/models/operations/secured-accounts-list.d.ts +5 -0
  167. package/dist/esm/models/operations/secured-accounts-list.d.ts.map +1 -1
  168. package/dist/esm/models/operations/secured-accounts-list.js +2 -0
  169. package/dist/esm/models/operations/secured-accounts-list.js.map +1 -1
  170. package/dist/esm/models/operations/secured-accounts-status.d.ts +5 -0
  171. package/dist/esm/models/operations/secured-accounts-status.d.ts.map +1 -1
  172. package/dist/esm/models/operations/secured-accounts-status.js +2 -0
  173. package/dist/esm/models/operations/secured-accounts-status.js.map +1 -1
  174. package/dist/esm/models/operations/signin-confirm.d.ts +148 -0
  175. package/dist/esm/models/operations/signin-confirm.d.ts.map +1 -0
  176. package/dist/esm/models/operations/signin-confirm.js +156 -0
  177. package/dist/esm/models/operations/signin-confirm.js.map +1 -0
  178. package/dist/esm/models/operations/signin-request.d.ts +115 -0
  179. package/dist/esm/models/operations/signin-request.d.ts.map +1 -0
  180. package/dist/esm/models/operations/signin-request.js +128 -0
  181. package/dist/esm/models/operations/signin-request.js.map +1 -0
  182. package/dist/esm/models/operations/verification-get-status.d.ts +10 -5
  183. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  184. package/dist/esm/models/operations/verification-get-status.js +5 -1
  185. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  186. package/dist/esm/sdk/census.d.ts +3 -3
  187. package/dist/esm/sdk/census.js +3 -3
  188. package/dist/esm/sdk/recovery.d.ts +19 -0
  189. package/dist/esm/sdk/recovery.d.ts.map +1 -0
  190. package/dist/esm/sdk/recovery.js +28 -0
  191. package/dist/esm/sdk/recovery.js.map +1 -0
  192. package/dist/esm/sdk/sdk.d.ts +6 -0
  193. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  194. package/dist/esm/sdk/sdk.js +10 -0
  195. package/dist/esm/sdk/sdk.js.map +1 -1
  196. package/dist/esm/sdk/sign-in.d.ts +19 -0
  197. package/dist/esm/sdk/sign-in.d.ts.map +1 -0
  198. package/dist/esm/sdk/sign-in.js +28 -0
  199. package/dist/esm/sdk/sign-in.js.map +1 -0
  200. package/dist/esm/sdk/verification.d.ts +1 -1
  201. package/dist/esm/sdk/verification.js +1 -1
  202. package/jsr.json +1 -1
  203. package/package.json +1 -1
  204. package/src/funcs/census-confirm-link.ts +1 -1
  205. package/src/funcs/census-send-by-number.ts +1 -1
  206. package/src/funcs/census-verify-token.ts +1 -1
  207. package/src/funcs/recovery-exchange.ts +184 -0
  208. package/src/funcs/recovery-other-route.ts +184 -0
  209. package/src/funcs/sign-in-confirm.ts +184 -0
  210. package/src/funcs/sign-in-request.ts +184 -0
  211. package/src/funcs/verification-get-status.ts +7 -2
  212. package/src/lib/config.ts +2 -12
  213. package/src/mcp-server/mcp-server.ts +1 -1
  214. package/src/mcp-server/server.ts +1 -1
  215. package/src/models/bot-shield-action.ts +62 -1
  216. package/src/models/error-body.ts +1 -1
  217. package/src/models/operations/actions-propose.ts +1 -1
  218. package/src/models/operations/gates-api-actions-create.ts +2 -2
  219. package/src/models/operations/gates-api-actions-list.ts +1 -1
  220. package/src/models/operations/gates-api-actions-request.ts +2 -2
  221. package/src/models/operations/gates-api-actions-set-state.ts +1 -1
  222. package/src/models/operations/gates-api-actions-update.ts +2 -2
  223. package/src/models/operations/index.ts +4 -0
  224. package/src/models/operations/recovery-exchange.ts +308 -0
  225. package/src/models/operations/recovery-other-route.ts +262 -0
  226. package/src/models/operations/sdk-create-verification-link.ts +10 -1
  227. package/src/models/operations/sdk-send-by-number.ts +1 -1
  228. package/src/models/operations/sdk-verify-token.ts +29 -4
  229. package/src/models/operations/secured-accounts-list.ts +7 -0
  230. package/src/models/operations/secured-accounts-status.ts +7 -0
  231. package/src/models/operations/signin-confirm.ts +383 -0
  232. package/src/models/operations/signin-request.ts +319 -0
  233. package/src/models/operations/verification-get-status.ts +14 -5
  234. package/src/sdk/census.ts +3 -3
  235. package/src/sdk/recovery.ts +49 -0
  236. package/src/sdk/sdk.ts +12 -0
  237. package/src/sdk/sign-in.ts +49 -0
  238. package/src/sdk/verification.ts +1 -1
package/README.md CHANGED
@@ -330,12 +330,22 @@ run();
330
330
  * [getOptions](docs/sdks/inlinepasskey/README.md#getoptions) - Start the inline passkey for one request
331
331
  * [complete](docs/sdks/inlinepasskey/README.md#complete) - Finish the inline passkey for one request
332
332
 
333
+ ### [Recovery](docs/sdks/recovery/README.md)
334
+
335
+ * [exchange](docs/sdks/recovery/README.md#exchange) - Redeem a recovery code
336
+ * [otherRoute](docs/sdks/recovery/README.md#otherroute) - Report another sign-in reset
337
+
333
338
  ### [SecuredAccounts](docs/sdks/securedaccounts/README.md)
334
339
 
335
340
  * [list](docs/sdks/securedaccounts/README.md#list) - List Secured Accounts
336
341
  * [revoke](docs/sdks/securedaccounts/README.md#revoke) - Revoke a Secured Account
337
342
  * [getStatus](docs/sdks/securedaccounts/README.md#getstatus) - Get Secured Account status
338
343
 
344
+ ### [SignIn](docs/sdks/signin/README.md)
345
+
346
+ * [request](docs/sdks/signin/README.md#request) - Ask for a passkey sign-in
347
+ * [confirm](docs/sdks/signin/README.md#confirm) - Redeem a passkey sign-in
348
+
339
349
  ### [Verification](docs/sdks/verification/README.md)
340
350
 
341
351
  * [getStatus](docs/sdks/verification/README.md#getstatus) - Check verification status
@@ -388,9 +398,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
388
398
  - [`gatesList`](docs/sdks/gates/README.md#list) - List gates
389
399
  - [`inlinePasskeyComplete`](docs/sdks/inlinepasskey/README.md#complete) - Finish the inline passkey for one request
390
400
  - [`inlinePasskeyGetOptions`](docs/sdks/inlinepasskey/README.md#getoptions) - Start the inline passkey for one request
401
+ - [`recoveryExchange`](docs/sdks/recovery/README.md#exchange) - Redeem a recovery code
402
+ - [`recoveryOtherRoute`](docs/sdks/recovery/README.md#otherroute) - Report another sign-in reset
391
403
  - [`securedAccountsGetStatus`](docs/sdks/securedaccounts/README.md#getstatus) - Get Secured Account status
392
404
  - [`securedAccountsList`](docs/sdks/securedaccounts/README.md#list) - List Secured Accounts
393
405
  - [`securedAccountsRevoke`](docs/sdks/securedaccounts/README.md#revoke) - Revoke a Secured Account
406
+ - [`signInConfirm`](docs/sdks/signin/README.md#confirm) - Redeem a passkey sign-in
407
+ - [`signInRequest`](docs/sdks/signin/README.md#request) - Ask for a passkey sign-in
394
408
  - [`verificationGetStatus`](docs/sdks/verification/README.md#getstatus) - Check verification status
395
409
 
396
410
  </details>
@@ -547,11 +561,9 @@ run();
547
561
 
548
562
  You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
549
563
 
550
- | Name | Server | Description |
551
- | ------------ | -------------------------------------------- | -------------------- |
552
- | `production` | `https://api.botshield.ai/operations` | Production (default) |
553
- | `staging` | `https://wg-staging.botshield.ai/operations` | Staging |
554
- | `local` | `http://localhost:9991/operations` | Local development |
564
+ | Name | Server | Description |
565
+ | ------------ | ------------------------------------- | -------------------- |
566
+ | `production` | `https://api.botshield.ai/operations` | Production (default) |
555
567
 
556
568
  #### Example
557
569