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,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
+ }
@@ -0,0 +1,319 @@
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 { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import * as types from "../../types/primitives.js";
11
+ import { SDKValidationError } from "../errors/sdk-validation-error.js";
12
+ import * as models from "../index.js";
13
+
14
+ export type SigninRequestSecurity = {
15
+ apiKeyAuth: string;
16
+ };
17
+
18
+ export type SigninRequestRequest = {
19
+ /**
20
+ * Your own reference for the account (the same `partner_user_ref` it was verified with). Hashed server-side; never stored or returned.
21
+ */
22
+ partnerUserRef: string;
23
+ };
24
+
25
+ export const SigninRequestTier = {
26
+ One: 1,
27
+ } as const;
28
+ export type SigninRequestTier = ClosedEnum<typeof SigninRequestTier>;
29
+
30
+ export type SigninRequestDataData = {
31
+ /**
32
+ * The only value your page gets.
33
+ */
34
+ requestId: string;
35
+ /**
36
+ * 2 minutes from now.
37
+ */
38
+ expiresAt: Date;
39
+ tier: SigninRequestTier;
40
+ /**
41
+ * The one page origin BotShield's frame will run under: your Sign-on Action's address.
42
+ */
43
+ pageOrigin: string;
44
+ /**
45
+ * Whether BotShield's QR may finish this sign-in (your Sign-on Action's QR switch; default off).
46
+ */
47
+ qr: boolean;
48
+ /**
49
+ * BotShield's QR address for this request, only when `qr` is true.
50
+ */
51
+ qrUrl: string | null;
52
+ };
53
+
54
+ export type SigninRequestData = {
55
+ data?: SigninRequestDataData | undefined;
56
+ /**
57
+ * Handler error. Arrives inside `data.error` with HTTP 200. Check for it before reading the result.
58
+ */
59
+ error?: models.ErrorBody | undefined;
60
+ };
61
+
62
+ /**
63
+ * The sign-in request. 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_not_set_up` (409 — no live Sign-on Action with a sign-in page here), `not_verified` (409 — not a verified account here; nothing was started), `account_paused` (409 — the customer's verified accounts are paused until they confirm again from a signed-in page), `unavailable` (503).
64
+ */
65
+ export type SigninRequestResponse = {
66
+ data: SigninRequestData;
67
+ };
68
+
69
+ /** @internal */
70
+ export const SigninRequestSecurity$inboundSchema: z.ZodType<
71
+ SigninRequestSecurity,
72
+ z.ZodTypeDef,
73
+ unknown
74
+ > = z.object({
75
+ ApiKeyAuth: types.string(),
76
+ }).transform((v) => {
77
+ return remap$(v, {
78
+ "ApiKeyAuth": "apiKeyAuth",
79
+ });
80
+ });
81
+ /** @internal */
82
+ export type SigninRequestSecurity$Outbound = {
83
+ ApiKeyAuth: string;
84
+ };
85
+
86
+ /** @internal */
87
+ export const SigninRequestSecurity$outboundSchema: z.ZodType<
88
+ SigninRequestSecurity$Outbound,
89
+ z.ZodTypeDef,
90
+ SigninRequestSecurity
91
+ > = z.object({
92
+ apiKeyAuth: z.string(),
93
+ }).transform((v) => {
94
+ return remap$(v, {
95
+ apiKeyAuth: "ApiKeyAuth",
96
+ });
97
+ });
98
+
99
+ export function signinRequestSecurityToJSON(
100
+ signinRequestSecurity: SigninRequestSecurity,
101
+ ): string {
102
+ return JSON.stringify(
103
+ SigninRequestSecurity$outboundSchema.parse(signinRequestSecurity),
104
+ );
105
+ }
106
+ export function signinRequestSecurityFromJSON(
107
+ jsonString: string,
108
+ ): SafeParseResult<SigninRequestSecurity, SDKValidationError> {
109
+ return safeParse(
110
+ jsonString,
111
+ (x) => SigninRequestSecurity$inboundSchema.parse(JSON.parse(x)),
112
+ `Failed to parse 'SigninRequestSecurity' from JSON`,
113
+ );
114
+ }
115
+
116
+ /** @internal */
117
+ export const SigninRequestRequest$inboundSchema: z.ZodType<
118
+ SigninRequestRequest,
119
+ z.ZodTypeDef,
120
+ unknown
121
+ > = z.object({
122
+ partner_user_ref: types.string(),
123
+ }).transform((v) => {
124
+ return remap$(v, {
125
+ "partner_user_ref": "partnerUserRef",
126
+ });
127
+ });
128
+ /** @internal */
129
+ export type SigninRequestRequest$Outbound = {
130
+ partner_user_ref: string;
131
+ };
132
+
133
+ /** @internal */
134
+ export const SigninRequestRequest$outboundSchema: z.ZodType<
135
+ SigninRequestRequest$Outbound,
136
+ z.ZodTypeDef,
137
+ SigninRequestRequest
138
+ > = z.object({
139
+ partnerUserRef: z.string(),
140
+ }).transform((v) => {
141
+ return remap$(v, {
142
+ partnerUserRef: "partner_user_ref",
143
+ });
144
+ });
145
+
146
+ export function signinRequestRequestToJSON(
147
+ signinRequestRequest: SigninRequestRequest,
148
+ ): string {
149
+ return JSON.stringify(
150
+ SigninRequestRequest$outboundSchema.parse(signinRequestRequest),
151
+ );
152
+ }
153
+ export function signinRequestRequestFromJSON(
154
+ jsonString: string,
155
+ ): SafeParseResult<SigninRequestRequest, SDKValidationError> {
156
+ return safeParse(
157
+ jsonString,
158
+ (x) => SigninRequestRequest$inboundSchema.parse(JSON.parse(x)),
159
+ `Failed to parse 'SigninRequestRequest' from JSON`,
160
+ );
161
+ }
162
+
163
+ /** @internal */
164
+ export const SigninRequestTier$inboundSchema: z.ZodNativeEnum<
165
+ typeof SigninRequestTier
166
+ > = z.nativeEnum(SigninRequestTier);
167
+ /** @internal */
168
+ export const SigninRequestTier$outboundSchema: z.ZodNativeEnum<
169
+ typeof SigninRequestTier
170
+ > = SigninRequestTier$inboundSchema;
171
+
172
+ /** @internal */
173
+ export const SigninRequestDataData$inboundSchema: z.ZodType<
174
+ SigninRequestDataData,
175
+ z.ZodTypeDef,
176
+ unknown
177
+ > = z.object({
178
+ request_id: types.string(),
179
+ expires_at: types.date(),
180
+ tier: SigninRequestTier$inboundSchema,
181
+ page_origin: types.string(),
182
+ qr: types.boolean(),
183
+ qr_url: types.nullable(types.string()),
184
+ }).transform((v) => {
185
+ return remap$(v, {
186
+ "request_id": "requestId",
187
+ "expires_at": "expiresAt",
188
+ "page_origin": "pageOrigin",
189
+ "qr_url": "qrUrl",
190
+ });
191
+ });
192
+ /** @internal */
193
+ export type SigninRequestDataData$Outbound = {
194
+ request_id: string;
195
+ expires_at: string;
196
+ tier: number;
197
+ page_origin: string;
198
+ qr: boolean;
199
+ qr_url: string | null;
200
+ };
201
+
202
+ /** @internal */
203
+ export const SigninRequestDataData$outboundSchema: z.ZodType<
204
+ SigninRequestDataData$Outbound,
205
+ z.ZodTypeDef,
206
+ SigninRequestDataData
207
+ > = z.object({
208
+ requestId: z.string(),
209
+ expiresAt: z.date().transform(v => v.toISOString()),
210
+ tier: SigninRequestTier$outboundSchema,
211
+ pageOrigin: z.string(),
212
+ qr: z.boolean(),
213
+ qrUrl: z.nullable(z.string()),
214
+ }).transform((v) => {
215
+ return remap$(v, {
216
+ requestId: "request_id",
217
+ expiresAt: "expires_at",
218
+ pageOrigin: "page_origin",
219
+ qrUrl: "qr_url",
220
+ });
221
+ });
222
+
223
+ export function signinRequestDataDataToJSON(
224
+ signinRequestDataData: SigninRequestDataData,
225
+ ): string {
226
+ return JSON.stringify(
227
+ SigninRequestDataData$outboundSchema.parse(signinRequestDataData),
228
+ );
229
+ }
230
+ export function signinRequestDataDataFromJSON(
231
+ jsonString: string,
232
+ ): SafeParseResult<SigninRequestDataData, SDKValidationError> {
233
+ return safeParse(
234
+ jsonString,
235
+ (x) => SigninRequestDataData$inboundSchema.parse(JSON.parse(x)),
236
+ `Failed to parse 'SigninRequestDataData' from JSON`,
237
+ );
238
+ }
239
+
240
+ /** @internal */
241
+ export const SigninRequestData$inboundSchema: z.ZodType<
242
+ SigninRequestData,
243
+ z.ZodTypeDef,
244
+ unknown
245
+ > = z.object({
246
+ data: types.optional(z.lazy(() => SigninRequestDataData$inboundSchema)),
247
+ error: types.optional(models.ErrorBody$inboundSchema),
248
+ });
249
+ /** @internal */
250
+ export type SigninRequestData$Outbound = {
251
+ data?: SigninRequestDataData$Outbound | undefined;
252
+ error?: models.ErrorBody$Outbound | undefined;
253
+ };
254
+
255
+ /** @internal */
256
+ export const SigninRequestData$outboundSchema: z.ZodType<
257
+ SigninRequestData$Outbound,
258
+ z.ZodTypeDef,
259
+ SigninRequestData
260
+ > = z.object({
261
+ data: z.lazy(() => SigninRequestDataData$outboundSchema).optional(),
262
+ error: models.ErrorBody$outboundSchema.optional(),
263
+ });
264
+
265
+ export function signinRequestDataToJSON(
266
+ signinRequestData: SigninRequestData,
267
+ ): string {
268
+ return JSON.stringify(
269
+ SigninRequestData$outboundSchema.parse(signinRequestData),
270
+ );
271
+ }
272
+ export function signinRequestDataFromJSON(
273
+ jsonString: string,
274
+ ): SafeParseResult<SigninRequestData, SDKValidationError> {
275
+ return safeParse(
276
+ jsonString,
277
+ (x) => SigninRequestData$inboundSchema.parse(JSON.parse(x)),
278
+ `Failed to parse 'SigninRequestData' from JSON`,
279
+ );
280
+ }
281
+
282
+ /** @internal */
283
+ export const SigninRequestResponse$inboundSchema: z.ZodType<
284
+ SigninRequestResponse,
285
+ z.ZodTypeDef,
286
+ unknown
287
+ > = z.object({
288
+ data: z.lazy(() => SigninRequestData$inboundSchema),
289
+ });
290
+ /** @internal */
291
+ export type SigninRequestResponse$Outbound = {
292
+ data: SigninRequestData$Outbound;
293
+ };
294
+
295
+ /** @internal */
296
+ export const SigninRequestResponse$outboundSchema: z.ZodType<
297
+ SigninRequestResponse$Outbound,
298
+ z.ZodTypeDef,
299
+ SigninRequestResponse
300
+ > = z.object({
301
+ data: z.lazy(() => SigninRequestData$outboundSchema),
302
+ });
303
+
304
+ export function signinRequestResponseToJSON(
305
+ signinRequestResponse: SigninRequestResponse,
306
+ ): string {
307
+ return JSON.stringify(
308
+ SigninRequestResponse$outboundSchema.parse(signinRequestResponse),
309
+ );
310
+ }
311
+ export function signinRequestResponseFromJSON(
312
+ jsonString: string,
313
+ ): SafeParseResult<SigninRequestResponse, SDKValidationError> {
314
+ return safeParse(
315
+ jsonString,
316
+ (x) => SigninRequestResponse$inboundSchema.parse(JSON.parse(x)),
317
+ `Failed to parse 'SigninRequestResponse' from JSON`,
318
+ );
319
+ }