botshield-sdk 4.0.0 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (203) hide show
  1. package/README.md +14 -0
  2. package/bin/mcp-server.js +385 -14
  3. package/bin/mcp-server.js.map +22 -18
  4. package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
  5. package/dist/commonjs/funcs/census-verify-token.js +1 -1
  6. package/dist/commonjs/funcs/recovery-exchange.d.ts +18 -0
  7. package/dist/commonjs/funcs/recovery-exchange.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/recovery-exchange.js +123 -0
  9. package/dist/commonjs/funcs/recovery-exchange.js.map +1 -0
  10. package/dist/commonjs/funcs/recovery-other-route.d.ts +18 -0
  11. package/dist/commonjs/funcs/recovery-other-route.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/recovery-other-route.js +123 -0
  13. package/dist/commonjs/funcs/recovery-other-route.js.map +1 -0
  14. package/dist/commonjs/funcs/sign-in-confirm.d.ts +18 -0
  15. package/dist/commonjs/funcs/sign-in-confirm.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/sign-in-confirm.js +123 -0
  17. package/dist/commonjs/funcs/sign-in-confirm.js.map +1 -0
  18. package/dist/commonjs/funcs/sign-in-request.d.ts +18 -0
  19. package/dist/commonjs/funcs/sign-in-request.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/sign-in-request.js +123 -0
  21. package/dist/commonjs/funcs/sign-in-request.js.map +1 -0
  22. package/dist/commonjs/funcs/verification-get-status.d.ts +1 -1
  23. package/dist/commonjs/funcs/verification-get-status.js +2 -1
  24. package/dist/commonjs/funcs/verification-get-status.js.map +1 -1
  25. package/dist/commonjs/lib/config.d.ts +2 -2
  26. package/dist/commonjs/lib/config.js +2 -2
  27. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  28. package/dist/commonjs/mcp-server/server.js +1 -1
  29. package/dist/commonjs/models/bot-shield-action.d.ts +36 -0
  30. package/dist/commonjs/models/bot-shield-action.d.ts.map +1 -1
  31. package/dist/commonjs/models/bot-shield-action.js +28 -1
  32. package/dist/commonjs/models/bot-shield-action.js.map +1 -1
  33. package/dist/commonjs/models/error-body.d.ts +1 -1
  34. package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +1 -1
  35. package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
  36. package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +1 -1
  37. package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
  38. package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +1 -1
  39. package/dist/commonjs/models/operations/index.d.ts +4 -0
  40. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  41. package/dist/commonjs/models/operations/index.js +4 -0
  42. package/dist/commonjs/models/operations/index.js.map +1 -1
  43. package/dist/commonjs/models/operations/recovery-exchange.d.ts +114 -0
  44. package/dist/commonjs/models/operations/recovery-exchange.d.ts.map +1 -0
  45. package/dist/commonjs/models/operations/recovery-exchange.js +164 -0
  46. package/dist/commonjs/models/operations/recovery-exchange.js.map +1 -0
  47. package/dist/commonjs/models/operations/recovery-other-route.d.ts +86 -0
  48. package/dist/commonjs/models/operations/recovery-other-route.d.ts.map +1 -0
  49. package/dist/commonjs/models/operations/recovery-other-route.js +145 -0
  50. package/dist/commonjs/models/operations/recovery-other-route.js.map +1 -0
  51. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +6 -1
  52. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  53. package/dist/commonjs/models/operations/sdk-create-verification-link.js +4 -0
  54. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  55. package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +1 -1
  56. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +15 -0
  57. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  58. package/dist/commonjs/models/operations/sdk-verify-token.js +10 -0
  59. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  60. package/dist/commonjs/models/operations/signin-confirm.d.ts +148 -0
  61. package/dist/commonjs/models/operations/signin-confirm.d.ts.map +1 -0
  62. package/dist/commonjs/models/operations/signin-confirm.js +202 -0
  63. package/dist/commonjs/models/operations/signin-confirm.js.map +1 -0
  64. package/dist/commonjs/models/operations/signin-request.d.ts +115 -0
  65. package/dist/commonjs/models/operations/signin-request.d.ts.map +1 -0
  66. package/dist/commonjs/models/operations/signin-request.js +174 -0
  67. package/dist/commonjs/models/operations/signin-request.js.map +1 -0
  68. package/dist/commonjs/models/operations/verification-get-status.d.ts +5 -0
  69. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  70. package/dist/commonjs/models/operations/verification-get-status.js +4 -0
  71. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  72. package/dist/commonjs/sdk/census.d.ts +1 -1
  73. package/dist/commonjs/sdk/census.js +1 -1
  74. package/dist/commonjs/sdk/recovery.d.ts +19 -0
  75. package/dist/commonjs/sdk/recovery.d.ts.map +1 -0
  76. package/dist/commonjs/sdk/recovery.js +32 -0
  77. package/dist/commonjs/sdk/recovery.js.map +1 -0
  78. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  79. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  80. package/dist/commonjs/sdk/sdk.js +10 -0
  81. package/dist/commonjs/sdk/sdk.js.map +1 -1
  82. package/dist/commonjs/sdk/sign-in.d.ts +19 -0
  83. package/dist/commonjs/sdk/sign-in.d.ts.map +1 -0
  84. package/dist/commonjs/sdk/sign-in.js +32 -0
  85. package/dist/commonjs/sdk/sign-in.js.map +1 -0
  86. package/dist/commonjs/sdk/verification.d.ts +1 -1
  87. package/dist/commonjs/sdk/verification.js +1 -1
  88. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  89. package/dist/esm/funcs/census-verify-token.js +1 -1
  90. package/dist/esm/funcs/recovery-exchange.d.ts +18 -0
  91. package/dist/esm/funcs/recovery-exchange.d.ts.map +1 -0
  92. package/dist/esm/funcs/recovery-exchange.js +87 -0
  93. package/dist/esm/funcs/recovery-exchange.js.map +1 -0
  94. package/dist/esm/funcs/recovery-other-route.d.ts +18 -0
  95. package/dist/esm/funcs/recovery-other-route.d.ts.map +1 -0
  96. package/dist/esm/funcs/recovery-other-route.js +87 -0
  97. package/dist/esm/funcs/recovery-other-route.js.map +1 -0
  98. package/dist/esm/funcs/sign-in-confirm.d.ts +18 -0
  99. package/dist/esm/funcs/sign-in-confirm.d.ts.map +1 -0
  100. package/dist/esm/funcs/sign-in-confirm.js +87 -0
  101. package/dist/esm/funcs/sign-in-confirm.js.map +1 -0
  102. package/dist/esm/funcs/sign-in-request.d.ts +18 -0
  103. package/dist/esm/funcs/sign-in-request.d.ts.map +1 -0
  104. package/dist/esm/funcs/sign-in-request.js +87 -0
  105. package/dist/esm/funcs/sign-in-request.js.map +1 -0
  106. package/dist/esm/funcs/verification-get-status.d.ts +1 -1
  107. package/dist/esm/funcs/verification-get-status.js +3 -2
  108. package/dist/esm/funcs/verification-get-status.js.map +1 -1
  109. package/dist/esm/lib/config.d.ts +2 -2
  110. package/dist/esm/lib/config.js +2 -2
  111. package/dist/esm/mcp-server/mcp-server.js +1 -1
  112. package/dist/esm/mcp-server/server.js +1 -1
  113. package/dist/esm/models/bot-shield-action.d.ts +36 -0
  114. package/dist/esm/models/bot-shield-action.d.ts.map +1 -1
  115. package/dist/esm/models/bot-shield-action.js +27 -0
  116. package/dist/esm/models/bot-shield-action.js.map +1 -1
  117. package/dist/esm/models/error-body.d.ts +1 -1
  118. package/dist/esm/models/operations/gates-api-actions-create.d.ts +1 -1
  119. package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
  120. package/dist/esm/models/operations/gates-api-actions-request.d.ts +1 -1
  121. package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
  122. package/dist/esm/models/operations/gates-api-actions-update.d.ts +1 -1
  123. package/dist/esm/models/operations/index.d.ts +4 -0
  124. package/dist/esm/models/operations/index.d.ts.map +1 -1
  125. package/dist/esm/models/operations/index.js +4 -0
  126. package/dist/esm/models/operations/index.js.map +1 -1
  127. package/dist/esm/models/operations/recovery-exchange.d.ts +114 -0
  128. package/dist/esm/models/operations/recovery-exchange.d.ts.map +1 -0
  129. package/dist/esm/models/operations/recovery-exchange.js +118 -0
  130. package/dist/esm/models/operations/recovery-exchange.js.map +1 -0
  131. package/dist/esm/models/operations/recovery-other-route.d.ts +86 -0
  132. package/dist/esm/models/operations/recovery-other-route.d.ts.map +1 -0
  133. package/dist/esm/models/operations/recovery-other-route.js +99 -0
  134. package/dist/esm/models/operations/recovery-other-route.js.map +1 -0
  135. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +6 -1
  136. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  137. package/dist/esm/models/operations/sdk-create-verification-link.js +4 -0
  138. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  139. package/dist/esm/models/operations/sdk-send-by-number.d.ts +1 -1
  140. package/dist/esm/models/operations/sdk-verify-token.d.ts +15 -0
  141. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  142. package/dist/esm/models/operations/sdk-verify-token.js +10 -0
  143. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  144. package/dist/esm/models/operations/signin-confirm.d.ts +148 -0
  145. package/dist/esm/models/operations/signin-confirm.d.ts.map +1 -0
  146. package/dist/esm/models/operations/signin-confirm.js +156 -0
  147. package/dist/esm/models/operations/signin-confirm.js.map +1 -0
  148. package/dist/esm/models/operations/signin-request.d.ts +115 -0
  149. package/dist/esm/models/operations/signin-request.d.ts.map +1 -0
  150. package/dist/esm/models/operations/signin-request.js +128 -0
  151. package/dist/esm/models/operations/signin-request.js.map +1 -0
  152. package/dist/esm/models/operations/verification-get-status.d.ts +5 -0
  153. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  154. package/dist/esm/models/operations/verification-get-status.js +4 -0
  155. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  156. package/dist/esm/sdk/census.d.ts +1 -1
  157. package/dist/esm/sdk/census.js +1 -1
  158. package/dist/esm/sdk/recovery.d.ts +19 -0
  159. package/dist/esm/sdk/recovery.d.ts.map +1 -0
  160. package/dist/esm/sdk/recovery.js +28 -0
  161. package/dist/esm/sdk/recovery.js.map +1 -0
  162. package/dist/esm/sdk/sdk.d.ts +6 -0
  163. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  164. package/dist/esm/sdk/sdk.js +10 -0
  165. package/dist/esm/sdk/sdk.js.map +1 -1
  166. package/dist/esm/sdk/sign-in.d.ts +19 -0
  167. package/dist/esm/sdk/sign-in.d.ts.map +1 -0
  168. package/dist/esm/sdk/sign-in.js +28 -0
  169. package/dist/esm/sdk/sign-in.js.map +1 -0
  170. package/dist/esm/sdk/verification.d.ts +1 -1
  171. package/dist/esm/sdk/verification.js +1 -1
  172. package/jsr.json +1 -1
  173. package/package.json +1 -1
  174. package/src/funcs/census-verify-token.ts +1 -1
  175. package/src/funcs/recovery-exchange.ts +184 -0
  176. package/src/funcs/recovery-other-route.ts +184 -0
  177. package/src/funcs/sign-in-confirm.ts +184 -0
  178. package/src/funcs/sign-in-request.ts +184 -0
  179. package/src/funcs/verification-get-status.ts +7 -2
  180. package/src/lib/config.ts +2 -2
  181. package/src/mcp-server/mcp-server.ts +1 -1
  182. package/src/mcp-server/server.ts +1 -1
  183. package/src/models/bot-shield-action.ts +61 -0
  184. package/src/models/error-body.ts +1 -1
  185. package/src/models/operations/gates-api-actions-create.ts +1 -1
  186. package/src/models/operations/gates-api-actions-list.ts +1 -1
  187. package/src/models/operations/gates-api-actions-request.ts +1 -1
  188. package/src/models/operations/gates-api-actions-set-state.ts +1 -1
  189. package/src/models/operations/gates-api-actions-update.ts +1 -1
  190. package/src/models/operations/index.ts +4 -0
  191. package/src/models/operations/recovery-exchange.ts +308 -0
  192. package/src/models/operations/recovery-other-route.ts +262 -0
  193. package/src/models/operations/sdk-create-verification-link.ts +10 -1
  194. package/src/models/operations/sdk-send-by-number.ts +1 -1
  195. package/src/models/operations/sdk-verify-token.ts +25 -0
  196. package/src/models/operations/signin-confirm.ts +383 -0
  197. package/src/models/operations/signin-request.ts +319 -0
  198. package/src/models/operations/verification-get-status.ts +9 -0
  199. package/src/sdk/census.ts +1 -1
  200. package/src/sdk/recovery.ts +49 -0
  201. package/src/sdk/sdk.ts +12 -0
  202. package/src/sdk/sign-in.ts +49 -0
  203. package/src/sdk/verification.ts +1 -1
@@ -30,6 +30,10 @@ export type SDKVerifyTokenRequest = {
30
30
  * 4.0: with your secret key, on a token whose link is pending, this confirms the link (same as sdk/confirm-link). The answer's `link` says whether it went live.
31
31
  */
32
32
  partnerUserRef?: string | undefined;
33
+ /**
34
+ * 4.0: the request YOUR server made for this attempt. When given, a token for any other request is refused (`valid: false`, `code: request_mismatch`) and is not spent.
35
+ */
36
+ expectedRequestId?: string | undefined;
33
37
  };
34
38
 
35
39
  /**
@@ -111,6 +115,10 @@ export type Claims = {
111
115
  * The environment of the key that started the request. Null on a token issued before 4.0, or when it was not known.
112
116
  */
113
117
  environment?: SDKVerifyTokenEnvironment | null | undefined;
118
+ /**
119
+ * 4.0: present for 72 hours after this verified account was recovered with Recover Account with BotShield: when it was recovered. Only when `trusted` is true.
120
+ */
121
+ recoveredAt?: Date | undefined;
114
122
  /**
115
123
  * 4.0: where the link stood for this token: `pending`, `live`, `expired` or `refused`. Absent on a plain check.
116
124
  */
@@ -157,6 +165,10 @@ export type SDKVerifyTokenDataData = {
157
165
  * Present when valid is false. A plain line, not a code. Includes: `Invalid token — not a BotShield verification token` (a token of another kind), `Invalid token — unknown environment`, and `Token was issued in the development environment; this key is production.` (or the reverse).
158
166
  */
159
167
  reason?: string | undefined;
168
+ /**
169
+ * 4.0: on some refusals (`valid: false`), a code beside `reason`: `secret_key_required` (called without your secret key; the token was not spent), `request_mismatch` (the token is for another request than `expected_request_id`; not spent).
170
+ */
171
+ code?: string | undefined;
160
172
  /**
161
173
  * Present when the token was valid but has expired.
162
174
  */
@@ -242,9 +254,11 @@ export const SDKVerifyTokenRequest$inboundSchema: z.ZodType<
242
254
  token: types.string(),
243
255
  audience: types.optional(types.string()),
244
256
  partner_user_ref: types.optional(types.string()),
257
+ expected_request_id: types.optional(types.string()),
245
258
  }).transform((v) => {
246
259
  return remap$(v, {
247
260
  "partner_user_ref": "partnerUserRef",
261
+ "expected_request_id": "expectedRequestId",
248
262
  });
249
263
  });
250
264
  /** @internal */
@@ -252,6 +266,7 @@ export type SDKVerifyTokenRequest$Outbound = {
252
266
  token: string;
253
267
  audience?: string | undefined;
254
268
  partner_user_ref?: string | undefined;
269
+ expected_request_id?: string | undefined;
255
270
  };
256
271
 
257
272
  /** @internal */
@@ -263,9 +278,11 @@ export const SDKVerifyTokenRequest$outboundSchema: z.ZodType<
263
278
  token: z.string(),
264
279
  audience: z.string().optional(),
265
280
  partnerUserRef: z.string().optional(),
281
+ expectedRequestId: z.string().optional(),
266
282
  }).transform((v) => {
267
283
  return remap$(v, {
268
284
  partnerUserRef: "partner_user_ref",
285
+ expectedRequestId: "expected_request_id",
269
286
  });
270
287
  });
271
288
 
@@ -331,6 +348,7 @@ export const Claims$inboundSchema: z.ZodType<Claims, z.ZodTypeDef, unknown> = z
331
348
  act: types.optional(types.string()),
332
349
  kind: z.nullable(Kind$inboundSchema).optional(),
333
350
  environment: z.nullable(SDKVerifyTokenEnvironment$inboundSchema).optional(),
351
+ recovered_at: types.optional(types.date()),
334
352
  link_state: types.optional(types.string()),
335
353
  }).transform((v) => {
336
354
  return remap$(v, {
@@ -341,6 +359,7 @@ export const Claims$inboundSchema: z.ZodType<Claims, z.ZodTypeDef, unknown> = z
341
359
  "age_over": "ageOver",
342
360
  "trusted_since": "trustedSince",
343
361
  "last_pass_at": "lastPassAt",
362
+ "recovered_at": "recoveredAt",
344
363
  "link_state": "linkState",
345
364
  });
346
365
  });
@@ -361,6 +380,7 @@ export type Claims$Outbound = {
361
380
  act?: string | undefined;
362
381
  kind?: string | null | undefined;
363
382
  environment?: string | null | undefined;
383
+ recovered_at?: string | undefined;
364
384
  link_state?: string | undefined;
365
385
  };
366
386
 
@@ -385,6 +405,7 @@ export const Claims$outboundSchema: z.ZodType<
385
405
  act: z.string().optional(),
386
406
  kind: z.nullable(Kind$outboundSchema).optional(),
387
407
  environment: z.nullable(SDKVerifyTokenEnvironment$outboundSchema).optional(),
408
+ recoveredAt: z.date().transform(v => v.toISOString()).optional(),
388
409
  linkState: z.string().optional(),
389
410
  }).transform((v) => {
390
411
  return remap$(v, {
@@ -395,6 +416,7 @@ export const Claims$outboundSchema: z.ZodType<
395
416
  ageOver: "age_over",
396
417
  trustedSince: "trusted_since",
397
418
  lastPassAt: "last_pass_at",
419
+ recoveredAt: "recovered_at",
398
420
  linkState: "link_state",
399
421
  });
400
422
  });
@@ -508,6 +530,7 @@ export const SDKVerifyTokenDataData$inboundSchema: z.ZodType<
508
530
  > = z.object({
509
531
  valid: types.boolean(),
510
532
  reason: types.optional(types.string()),
533
+ code: types.optional(types.string()),
511
534
  expired_at: z.nullable(types.date()).optional(),
512
535
  claims: z.nullable(z.lazy(() => Claims$inboundSchema)).optional(),
513
536
  replayed: types.optional(types.boolean()),
@@ -522,6 +545,7 @@ export const SDKVerifyTokenDataData$inboundSchema: z.ZodType<
522
545
  export type SDKVerifyTokenDataData$Outbound = {
523
546
  valid: boolean;
524
547
  reason?: string | undefined;
548
+ code?: string | undefined;
525
549
  expired_at?: string | null | undefined;
526
550
  claims?: Claims$Outbound | null | undefined;
527
551
  replayed?: boolean | undefined;
@@ -537,6 +561,7 @@ export const SDKVerifyTokenDataData$outboundSchema: z.ZodType<
537
561
  > = z.object({
538
562
  valid: z.boolean(),
539
563
  reason: z.string().optional(),
564
+ code: z.string().optional(),
540
565
  expiredAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
541
566
  claims: z.nullable(z.lazy(() => Claims$outboundSchema)).optional(),
542
567
  replayed: z.boolean().optional(),
@@ -0,0 +1,383 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import * as openEnums from "../../types/enums.js";
9
+ import { ClosedEnum, OpenEnum } from "../../types/enums.js";
10
+ import { Result as SafeParseResult } from "../../types/fp.js";
11
+ import * as types from "../../types/primitives.js";
12
+ import { SDKValidationError } from "../errors/sdk-validation-error.js";
13
+ import * as models from "../index.js";
14
+
15
+ export type SigninConfirmSecurity = {
16
+ apiKeyAuth: string;
17
+ };
18
+
19
+ export type SigninConfirmRequest = {
20
+ /**
21
+ * The request your server made with signin/request.
22
+ */
23
+ requestId: string;
24
+ /**
25
+ * The account this attempt is for. When sent, a sign-in for any other account is refused (`signin_wrong_account`).
26
+ */
27
+ partnerUserRef?: string | undefined;
28
+ };
29
+
30
+ export const SigninConfirmEnvironment = {
31
+ Development: "development",
32
+ Production: "production",
33
+ } as const;
34
+ export type SigninConfirmEnvironment = OpenEnum<
35
+ typeof SigninConfirmEnvironment
36
+ >;
37
+
38
+ /**
39
+ * `inline`: the passkey on your page. `qr`: BotShield's QR (only where your Sign-on Action has it on).
40
+ */
41
+ export const SigninConfirmFinishedBy = {
42
+ Inline: "inline",
43
+ Qr: "qr",
44
+ } as const;
45
+ /**
46
+ * `inline`: the passkey on your page. `qr`: BotShield's QR (only where your Sign-on Action has it on).
47
+ */
48
+ export type SigninConfirmFinishedBy = OpenEnum<typeof SigninConfirmFinishedBy>;
49
+
50
+ export const SigninConfirmTier = {
51
+ One: 1,
52
+ } as const;
53
+ export type SigninConfirmTier = ClosedEnum<typeof SigninConfirmTier>;
54
+
55
+ export type SigninConfirmDataData = {
56
+ /**
57
+ * Always true on success.
58
+ */
59
+ signedIn: boolean;
60
+ requestId: string;
61
+ /**
62
+ * Your Sign-on Action's key.
63
+ */
64
+ act: string | null;
65
+ /**
66
+ * The verified account's per-company handle (`OP_…`), as `account.secured` gave it.
67
+ */
68
+ handle: string;
69
+ /**
70
+ * When the passkey was used.
71
+ */
72
+ verifiedAt: Date;
73
+ environment: SigninConfirmEnvironment;
74
+ /**
75
+ * `inline`: the passkey on your page. `qr`: BotShield's QR (only where your Sign-on Action has it on).
76
+ */
77
+ finishedBy: SigninConfirmFinishedBy;
78
+ tier: SigninConfirmTier;
79
+ };
80
+
81
+ export type SigninConfirmData = {
82
+ data?: SigninConfirmDataData | undefined;
83
+ /**
84
+ * Handler error. Arrives inside `data.error` with HTTP 200. Check for it before reading the result.
85
+ */
86
+ error?: models.ErrorBody | undefined;
87
+ };
88
+
89
+ /**
90
+ * Signed in. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key; a site key `pk_…` is refused), `org_not_found` (404), `signin_unknown` (404 — no sign-in your server asked for has that id; also another company's or environment's), `signin_pending` (409 — not confirmed yet), `signin_refused` (409 — not confirmed; do not sign the customer in), `signin_expired` (410 — the request or its answer is more than 2 minutes old), `signin_used` (409 — already redeemed), `signin_wrong_account` (409 — for a different account from `partner_user_ref`), `unavailable` (503).
91
+ */
92
+ export type SigninConfirmResponse = {
93
+ data: SigninConfirmData;
94
+ };
95
+
96
+ /** @internal */
97
+ export const SigninConfirmSecurity$inboundSchema: z.ZodType<
98
+ SigninConfirmSecurity,
99
+ z.ZodTypeDef,
100
+ unknown
101
+ > = z.object({
102
+ ApiKeyAuth: types.string(),
103
+ }).transform((v) => {
104
+ return remap$(v, {
105
+ "ApiKeyAuth": "apiKeyAuth",
106
+ });
107
+ });
108
+ /** @internal */
109
+ export type SigninConfirmSecurity$Outbound = {
110
+ ApiKeyAuth: string;
111
+ };
112
+
113
+ /** @internal */
114
+ export const SigninConfirmSecurity$outboundSchema: z.ZodType<
115
+ SigninConfirmSecurity$Outbound,
116
+ z.ZodTypeDef,
117
+ SigninConfirmSecurity
118
+ > = z.object({
119
+ apiKeyAuth: z.string(),
120
+ }).transform((v) => {
121
+ return remap$(v, {
122
+ apiKeyAuth: "ApiKeyAuth",
123
+ });
124
+ });
125
+
126
+ export function signinConfirmSecurityToJSON(
127
+ signinConfirmSecurity: SigninConfirmSecurity,
128
+ ): string {
129
+ return JSON.stringify(
130
+ SigninConfirmSecurity$outboundSchema.parse(signinConfirmSecurity),
131
+ );
132
+ }
133
+ export function signinConfirmSecurityFromJSON(
134
+ jsonString: string,
135
+ ): SafeParseResult<SigninConfirmSecurity, SDKValidationError> {
136
+ return safeParse(
137
+ jsonString,
138
+ (x) => SigninConfirmSecurity$inboundSchema.parse(JSON.parse(x)),
139
+ `Failed to parse 'SigninConfirmSecurity' from JSON`,
140
+ );
141
+ }
142
+
143
+ /** @internal */
144
+ export const SigninConfirmRequest$inboundSchema: z.ZodType<
145
+ SigninConfirmRequest,
146
+ z.ZodTypeDef,
147
+ unknown
148
+ > = z.object({
149
+ request_id: types.string(),
150
+ partner_user_ref: types.optional(types.string()),
151
+ }).transform((v) => {
152
+ return remap$(v, {
153
+ "request_id": "requestId",
154
+ "partner_user_ref": "partnerUserRef",
155
+ });
156
+ });
157
+ /** @internal */
158
+ export type SigninConfirmRequest$Outbound = {
159
+ request_id: string;
160
+ partner_user_ref?: string | undefined;
161
+ };
162
+
163
+ /** @internal */
164
+ export const SigninConfirmRequest$outboundSchema: z.ZodType<
165
+ SigninConfirmRequest$Outbound,
166
+ z.ZodTypeDef,
167
+ SigninConfirmRequest
168
+ > = z.object({
169
+ requestId: z.string(),
170
+ partnerUserRef: z.string().optional(),
171
+ }).transform((v) => {
172
+ return remap$(v, {
173
+ requestId: "request_id",
174
+ partnerUserRef: "partner_user_ref",
175
+ });
176
+ });
177
+
178
+ export function signinConfirmRequestToJSON(
179
+ signinConfirmRequest: SigninConfirmRequest,
180
+ ): string {
181
+ return JSON.stringify(
182
+ SigninConfirmRequest$outboundSchema.parse(signinConfirmRequest),
183
+ );
184
+ }
185
+ export function signinConfirmRequestFromJSON(
186
+ jsonString: string,
187
+ ): SafeParseResult<SigninConfirmRequest, SDKValidationError> {
188
+ return safeParse(
189
+ jsonString,
190
+ (x) => SigninConfirmRequest$inboundSchema.parse(JSON.parse(x)),
191
+ `Failed to parse 'SigninConfirmRequest' from JSON`,
192
+ );
193
+ }
194
+
195
+ /** @internal */
196
+ export const SigninConfirmEnvironment$inboundSchema: z.ZodType<
197
+ SigninConfirmEnvironment,
198
+ z.ZodTypeDef,
199
+ unknown
200
+ > = openEnums.inboundSchema(SigninConfirmEnvironment);
201
+ /** @internal */
202
+ export const SigninConfirmEnvironment$outboundSchema: z.ZodType<
203
+ string,
204
+ z.ZodTypeDef,
205
+ SigninConfirmEnvironment
206
+ > = openEnums.outboundSchema(SigninConfirmEnvironment);
207
+
208
+ /** @internal */
209
+ export const SigninConfirmFinishedBy$inboundSchema: z.ZodType<
210
+ SigninConfirmFinishedBy,
211
+ z.ZodTypeDef,
212
+ unknown
213
+ > = openEnums.inboundSchema(SigninConfirmFinishedBy);
214
+ /** @internal */
215
+ export const SigninConfirmFinishedBy$outboundSchema: z.ZodType<
216
+ string,
217
+ z.ZodTypeDef,
218
+ SigninConfirmFinishedBy
219
+ > = openEnums.outboundSchema(SigninConfirmFinishedBy);
220
+
221
+ /** @internal */
222
+ export const SigninConfirmTier$inboundSchema: z.ZodNativeEnum<
223
+ typeof SigninConfirmTier
224
+ > = z.nativeEnum(SigninConfirmTier);
225
+ /** @internal */
226
+ export const SigninConfirmTier$outboundSchema: z.ZodNativeEnum<
227
+ typeof SigninConfirmTier
228
+ > = SigninConfirmTier$inboundSchema;
229
+
230
+ /** @internal */
231
+ export const SigninConfirmDataData$inboundSchema: z.ZodType<
232
+ SigninConfirmDataData,
233
+ z.ZodTypeDef,
234
+ unknown
235
+ > = z.object({
236
+ signed_in: types.boolean(),
237
+ request_id: types.string(),
238
+ act: types.nullable(types.string()),
239
+ handle: types.string(),
240
+ verified_at: types.date(),
241
+ environment: SigninConfirmEnvironment$inboundSchema,
242
+ finished_by: SigninConfirmFinishedBy$inboundSchema,
243
+ tier: SigninConfirmTier$inboundSchema,
244
+ }).transform((v) => {
245
+ return remap$(v, {
246
+ "signed_in": "signedIn",
247
+ "request_id": "requestId",
248
+ "verified_at": "verifiedAt",
249
+ "finished_by": "finishedBy",
250
+ });
251
+ });
252
+ /** @internal */
253
+ export type SigninConfirmDataData$Outbound = {
254
+ signed_in: boolean;
255
+ request_id: string;
256
+ act: string | null;
257
+ handle: string;
258
+ verified_at: string;
259
+ environment: string;
260
+ finished_by: string;
261
+ tier: number;
262
+ };
263
+
264
+ /** @internal */
265
+ export const SigninConfirmDataData$outboundSchema: z.ZodType<
266
+ SigninConfirmDataData$Outbound,
267
+ z.ZodTypeDef,
268
+ SigninConfirmDataData
269
+ > = z.object({
270
+ signedIn: z.boolean(),
271
+ requestId: z.string(),
272
+ act: z.nullable(z.string()),
273
+ handle: z.string(),
274
+ verifiedAt: z.date().transform(v => v.toISOString()),
275
+ environment: SigninConfirmEnvironment$outboundSchema,
276
+ finishedBy: SigninConfirmFinishedBy$outboundSchema,
277
+ tier: SigninConfirmTier$outboundSchema,
278
+ }).transform((v) => {
279
+ return remap$(v, {
280
+ signedIn: "signed_in",
281
+ requestId: "request_id",
282
+ verifiedAt: "verified_at",
283
+ finishedBy: "finished_by",
284
+ });
285
+ });
286
+
287
+ export function signinConfirmDataDataToJSON(
288
+ signinConfirmDataData: SigninConfirmDataData,
289
+ ): string {
290
+ return JSON.stringify(
291
+ SigninConfirmDataData$outboundSchema.parse(signinConfirmDataData),
292
+ );
293
+ }
294
+ export function signinConfirmDataDataFromJSON(
295
+ jsonString: string,
296
+ ): SafeParseResult<SigninConfirmDataData, SDKValidationError> {
297
+ return safeParse(
298
+ jsonString,
299
+ (x) => SigninConfirmDataData$inboundSchema.parse(JSON.parse(x)),
300
+ `Failed to parse 'SigninConfirmDataData' from JSON`,
301
+ );
302
+ }
303
+
304
+ /** @internal */
305
+ export const SigninConfirmData$inboundSchema: z.ZodType<
306
+ SigninConfirmData,
307
+ z.ZodTypeDef,
308
+ unknown
309
+ > = z.object({
310
+ data: types.optional(z.lazy(() => SigninConfirmDataData$inboundSchema)),
311
+ error: types.optional(models.ErrorBody$inboundSchema),
312
+ });
313
+ /** @internal */
314
+ export type SigninConfirmData$Outbound = {
315
+ data?: SigninConfirmDataData$Outbound | undefined;
316
+ error?: models.ErrorBody$Outbound | undefined;
317
+ };
318
+
319
+ /** @internal */
320
+ export const SigninConfirmData$outboundSchema: z.ZodType<
321
+ SigninConfirmData$Outbound,
322
+ z.ZodTypeDef,
323
+ SigninConfirmData
324
+ > = z.object({
325
+ data: z.lazy(() => SigninConfirmDataData$outboundSchema).optional(),
326
+ error: models.ErrorBody$outboundSchema.optional(),
327
+ });
328
+
329
+ export function signinConfirmDataToJSON(
330
+ signinConfirmData: SigninConfirmData,
331
+ ): string {
332
+ return JSON.stringify(
333
+ SigninConfirmData$outboundSchema.parse(signinConfirmData),
334
+ );
335
+ }
336
+ export function signinConfirmDataFromJSON(
337
+ jsonString: string,
338
+ ): SafeParseResult<SigninConfirmData, SDKValidationError> {
339
+ return safeParse(
340
+ jsonString,
341
+ (x) => SigninConfirmData$inboundSchema.parse(JSON.parse(x)),
342
+ `Failed to parse 'SigninConfirmData' from JSON`,
343
+ );
344
+ }
345
+
346
+ /** @internal */
347
+ export const SigninConfirmResponse$inboundSchema: z.ZodType<
348
+ SigninConfirmResponse,
349
+ z.ZodTypeDef,
350
+ unknown
351
+ > = z.object({
352
+ data: z.lazy(() => SigninConfirmData$inboundSchema),
353
+ });
354
+ /** @internal */
355
+ export type SigninConfirmResponse$Outbound = {
356
+ data: SigninConfirmData$Outbound;
357
+ };
358
+
359
+ /** @internal */
360
+ export const SigninConfirmResponse$outboundSchema: z.ZodType<
361
+ SigninConfirmResponse$Outbound,
362
+ z.ZodTypeDef,
363
+ SigninConfirmResponse
364
+ > = z.object({
365
+ data: z.lazy(() => SigninConfirmData$outboundSchema),
366
+ });
367
+
368
+ export function signinConfirmResponseToJSON(
369
+ signinConfirmResponse: SigninConfirmResponse,
370
+ ): string {
371
+ return JSON.stringify(
372
+ SigninConfirmResponse$outboundSchema.parse(signinConfirmResponse),
373
+ );
374
+ }
375
+ export function signinConfirmResponseFromJSON(
376
+ jsonString: string,
377
+ ): SafeParseResult<SigninConfirmResponse, SDKValidationError> {
378
+ return safeParse(
379
+ jsonString,
380
+ (x) => SigninConfirmResponse$inboundSchema.parse(JSON.parse(x)),
381
+ `Failed to parse 'SigninConfirmResponse' from JSON`,
382
+ );
383
+ }