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
@@ -0,0 +1,184 @@
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
+ * Report another sign-in reset
31
+ *
32
+ * @remarks
33
+ * Tell BotShield that your other way to reset sign-in (a link by email, a code by text) was started for a verified account, by its handle. BotShield tells the person ("<Company> sign-in reset by email · It works from <day>. Not you? Open BotShield."), at most once per account in 6 hours. The answer is the same whether or not the handle is a live verified account.
34
+ */
35
+ export function recoveryOtherRoute(
36
+ client: BotShieldCore,
37
+ security: operations.RecoveryOtherRouteSecurity,
38
+ request: operations.RecoveryOtherRouteRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.RecoveryOtherRouteResponse,
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.RecoveryOtherRouteSecurity,
66
+ request: operations.RecoveryOtherRouteRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.RecoveryOtherRouteResponse,
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) => operations.RecoveryOtherRouteRequest$outboundSchema.parse(value),
89
+ "Input validation failed",
90
+ );
91
+ if (!parsed.ok) {
92
+ return [parsed, { status: "invalid" }];
93
+ }
94
+ const payload = parsed.value;
95
+ const body = encodeJSON("body", payload, { explode: true });
96
+
97
+ const path = pathToFunc("/recovery/other-route")();
98
+
99
+ const headers = new Headers(compactMap({
100
+ "Content-Type": "application/json",
101
+ Accept: "application/json",
102
+ }));
103
+
104
+ const requestSecurity = resolveSecurity(
105
+ [
106
+ {
107
+ fieldName: "Authorization",
108
+ type: "apiKey:header",
109
+ value: security?.apiKeyAuth,
110
+ },
111
+ ],
112
+ );
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "RecoveryOtherRoute",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: security,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "POST",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ body: body,
136
+ userAgent: client._options.userAgent,
137
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
138
+ }, options);
139
+ if (!requestRes.ok) {
140
+ return [requestRes, { status: "invalid" }];
141
+ }
142
+ const req = requestRes.value;
143
+
144
+ const doResult = await client._do(req, {
145
+ context,
146
+ isErrorStatusCode: (statusCode: number) =>
147
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.RecoveryOtherRouteResponse,
162
+ | errors.InvalidInputError
163
+ | errors.ErrorResponse
164
+ | BotShieldError
165
+ | ResponseValidationError
166
+ | ConnectionError
167
+ | RequestAbortedError
168
+ | RequestTimeoutError
169
+ | InvalidRequestError
170
+ | UnexpectedClientError
171
+ | SDKValidationError
172
+ >(
173
+ M.json(200, operations.RecoveryOtherRouteResponse$inboundSchema),
174
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
175
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
176
+ M.fail("4XX"),
177
+ M.fail("5XX"),
178
+ )(response, req, { extraFields: responseFields });
179
+ if (!result.ok) {
180
+ return [result, { status: "complete", request: req, response }];
181
+ }
182
+
183
+ return [result, { status: "complete", request: req, response }];
184
+ }
@@ -0,0 +1,184 @@
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
+ * Redeem a passkey sign-in
31
+ *
32
+ * @remarks
33
+ * Your SERVER redeems a sign-in with your secret key and the `request_id` IT made for this attempt: once, within 2 minutes of the passkey. The page's message from the frame is only a cue to call this. Send `partner_user_ref` to have a sign-in for any other account refused. The sign-in's token is not checked with verify-token (which refuses it), and verification/status never returns it.
34
+ */
35
+ export function signInConfirm(
36
+ client: BotShieldCore,
37
+ security: operations.SigninConfirmSecurity,
38
+ request: operations.SigninConfirmRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.SigninConfirmResponse,
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.SigninConfirmSecurity,
66
+ request: operations.SigninConfirmRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.SigninConfirmResponse,
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) => operations.SigninConfirmRequest$outboundSchema.parse(value),
89
+ "Input validation failed",
90
+ );
91
+ if (!parsed.ok) {
92
+ return [parsed, { status: "invalid" }];
93
+ }
94
+ const payload = parsed.value;
95
+ const body = encodeJSON("body", payload, { explode: true });
96
+
97
+ const path = pathToFunc("/signin/confirm")();
98
+
99
+ const headers = new Headers(compactMap({
100
+ "Content-Type": "application/json",
101
+ Accept: "application/json",
102
+ }));
103
+
104
+ const requestSecurity = resolveSecurity(
105
+ [
106
+ {
107
+ fieldName: "Authorization",
108
+ type: "apiKey:header",
109
+ value: security?.apiKeyAuth,
110
+ },
111
+ ],
112
+ );
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "SigninConfirm",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: security,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "POST",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ body: body,
136
+ userAgent: client._options.userAgent,
137
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
138
+ }, options);
139
+ if (!requestRes.ok) {
140
+ return [requestRes, { status: "invalid" }];
141
+ }
142
+ const req = requestRes.value;
143
+
144
+ const doResult = await client._do(req, {
145
+ context,
146
+ isErrorStatusCode: (statusCode: number) =>
147
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.SigninConfirmResponse,
162
+ | errors.InvalidInputError
163
+ | errors.ErrorResponse
164
+ | BotShieldError
165
+ | ResponseValidationError
166
+ | ConnectionError
167
+ | RequestAbortedError
168
+ | RequestTimeoutError
169
+ | InvalidRequestError
170
+ | UnexpectedClientError
171
+ | SDKValidationError
172
+ >(
173
+ M.json(200, operations.SigninConfirmResponse$inboundSchema),
174
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
175
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
176
+ M.fail("4XX"),
177
+ M.fail("5XX"),
178
+ )(response, req, { extraFields: responseFields });
179
+ if (!result.ok) {
180
+ return [result, { status: "complete", request: req, response }];
181
+ }
182
+
183
+ return [result, { status: "complete", request: req, response }];
184
+ }
@@ -0,0 +1,184 @@
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
+ * Ask for a passkey sign-in
31
+ *
32
+ * @remarks
33
+ * Your SERVER asks for a sign-in for ONE of your accounts, after the password has passed or after the customer named their account. Hand the page only `request_id`. Answers only for an account that is already an active verified account here; otherwise `not_verified`, nothing is started, and you do not show the button. It never links an account. A paused account is refused (`account_paused`). The request lives 2 minutes. Needs a live Sign-on Action with your sign-in page's address (BotShield Console › Verified Accounts › BotShield Actions).
34
+ */
35
+ export function signInRequest(
36
+ client: BotShieldCore,
37
+ security: operations.SigninRequestSecurity,
38
+ request: operations.SigninRequestRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ operations.SigninRequestResponse,
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.SigninRequestSecurity,
66
+ request: operations.SigninRequestRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ operations.SigninRequestResponse,
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) => operations.SigninRequestRequest$outboundSchema.parse(value),
89
+ "Input validation failed",
90
+ );
91
+ if (!parsed.ok) {
92
+ return [parsed, { status: "invalid" }];
93
+ }
94
+ const payload = parsed.value;
95
+ const body = encodeJSON("body", payload, { explode: true });
96
+
97
+ const path = pathToFunc("/signin/request")();
98
+
99
+ const headers = new Headers(compactMap({
100
+ "Content-Type": "application/json",
101
+ Accept: "application/json",
102
+ }));
103
+
104
+ const requestSecurity = resolveSecurity(
105
+ [
106
+ {
107
+ fieldName: "Authorization",
108
+ type: "apiKey:header",
109
+ value: security?.apiKeyAuth,
110
+ },
111
+ ],
112
+ );
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "SigninRequest",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: security,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "POST",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ body: body,
136
+ userAgent: client._options.userAgent,
137
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
138
+ }, options);
139
+ if (!requestRes.ok) {
140
+ return [requestRes, { status: "invalid" }];
141
+ }
142
+ const req = requestRes.value;
143
+
144
+ const doResult = await client._do(req, {
145
+ context,
146
+ isErrorStatusCode: (statusCode: number) =>
147
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.SigninRequestResponse,
162
+ | errors.InvalidInputError
163
+ | errors.ErrorResponse
164
+ | BotShieldError
165
+ | ResponseValidationError
166
+ | ConnectionError
167
+ | RequestAbortedError
168
+ | RequestTimeoutError
169
+ | InvalidRequestError
170
+ | UnexpectedClientError
171
+ | SDKValidationError
172
+ >(
173
+ M.json(200, operations.SigninRequestResponse$inboundSchema),
174
+ M.jsonErr(400, errors.InvalidInputError$inboundSchema),
175
+ M.jsonErr(500, errors.ErrorResponse$inboundSchema),
176
+ M.fail("4XX"),
177
+ M.fail("5XX"),
178
+ )(response, req, { extraFields: responseFields });
179
+ if (!result.ok) {
180
+ return [result, { status: "complete", request: req, response }];
181
+ }
182
+
183
+ return [result, { status: "complete", request: req, response }];
184
+ }
@@ -3,7 +3,7 @@
3
3
  */
4
4
 
5
5
  import { BotShieldCore } from "../core.js";
6
- import { encodeFormQuery } from "../lib/encodings.js";
6
+ import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
7
  import { matchStatusCode } from "../lib/http.js";
8
8
  import * as M from "../lib/matchers.js";
9
9
  import { compactMap } from "../lib/primitives.js";
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
30
30
  * Check verification status
31
31
  *
32
32
  * @remarks
33
- * 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"`.
33
+ * 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"`. Knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
34
34
  */
35
35
  export function verificationGetStatus(
36
36
  client: BotShieldCore,
@@ -103,6 +103,11 @@ async function $do(
103
103
 
104
104
  const headers = new Headers(compactMap({
105
105
  Accept: "application/json",
106
+ "X-BotShield-Request-Secret": encodeSimple(
107
+ "X-BotShield-Request-Secret",
108
+ payload["X-BotShield-Request-Secret"],
109
+ { explode: false, charEncoding: "none" },
110
+ ),
106
111
  }));
107
112
 
108
113
  const requestSecurity = resolveSecurity(
package/src/lib/config.ts CHANGED
@@ -12,21 +12,11 @@ import { Params, pathToFunc } from "./url.js";
12
12
  * Production (default)
13
13
  */
14
14
  export const ServerProduction = "production";
15
- /**
16
- * Staging
17
- */
18
- export const ServerStaging = "staging";
19
- /**
20
- * Local development
21
- */
22
- export const ServerLocal = "local";
23
15
  /**
24
16
  * Contains the list of servers available to the SDK
25
17
  */
26
18
  export const ServerList = {
27
19
  [ServerProduction]: "https://api.botshield.ai/operations",
28
- [ServerStaging]: "https://wg-staging.botshield.ai/operations",
29
- [ServerLocal]: "http://localhost:9991/operations",
30
20
  } as const;
31
21
 
32
22
  export type SDKOptions = {
@@ -73,7 +63,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
73
63
  export const SDK_METADATA = {
74
64
  language: "typescript",
75
65
  openapiDocVersion: "2.0.0",
76
- sdkVersion: "4.0.0",
66
+ sdkVersion: "4.0.3",
77
67
  genVersion: "2.934.1",
78
- userAgent: "speakeasy-sdk/typescript 4.0.0 2.934.1 2.0.0 botshield-sdk",
68
+ userAgent: "speakeasy-sdk/typescript 4.0.3 2.934.1 2.0.0 botshield-sdk",
79
69
  } as const;
@@ -19,7 +19,7 @@ const routes = buildRouteMap({
19
19
  export const app = buildApplication(routes, {
20
20
  name: "mcp",
21
21
  versionInfo: {
22
- currentVersion: "4.0.0",
22
+ currentVersion: "4.0.3",
23
23
  },
24
24
  });
25
25
 
@@ -27,7 +27,7 @@ export function createMCPServer(deps: {
27
27
  }) {
28
28
  const server = new McpServer({
29
29
  name: "BotShield",
30
- version: "4.0.0",
30
+ version: "4.0.3",
31
31
  });
32
32
 
33
33
  const client = new BotShieldCore({