botshield-sdk 2.0.2 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (275) hide show
  1. package/README.md +18 -46
  2. package/bin/mcp-server.js +596 -468
  3. package/bin/mcp-server.js.map +32 -29
  4. package/dist/commonjs/funcs/actions-propose-action.d.ts +1 -1
  5. package/dist/commonjs/funcs/actions-propose-action.js +1 -1
  6. package/dist/commonjs/funcs/census-get-partner-config.js +2 -78
  7. package/dist/commonjs/funcs/census-get-partner-config.js.map +1 -1
  8. package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
  9. package/dist/commonjs/funcs/census-verify-token.js +1 -79
  10. package/dist/commonjs/funcs/census-verify-token.js.map +1 -1
  11. package/dist/commonjs/funcs/secured-accounts-get-status.d.ts +18 -0
  12. package/dist/commonjs/funcs/secured-accounts-get-status.d.ts.map +1 -0
  13. package/dist/commonjs/funcs/secured-accounts-get-status.js +126 -0
  14. package/dist/commonjs/funcs/secured-accounts-get-status.js.map +1 -0
  15. package/dist/commonjs/funcs/secured-accounts-list.d.ts +18 -0
  16. package/dist/commonjs/funcs/secured-accounts-list.d.ts.map +1 -0
  17. package/dist/commonjs/funcs/secured-accounts-list.js +129 -0
  18. package/dist/commonjs/funcs/secured-accounts-list.js.map +1 -0
  19. package/dist/commonjs/funcs/secured-accounts-revoke.d.ts +18 -0
  20. package/dist/commonjs/funcs/secured-accounts-revoke.d.ts.map +1 -0
  21. package/dist/commonjs/funcs/secured-accounts-revoke.js +123 -0
  22. package/dist/commonjs/funcs/secured-accounts-revoke.js.map +1 -0
  23. package/dist/commonjs/funcs/verification-get-status.js +0 -78
  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/lib/security.d.ts.map +1 -1
  28. package/dist/commonjs/lib/security.js +0 -91
  29. package/dist/commonjs/lib/security.js.map +1 -1
  30. package/dist/commonjs/mcp-server/cli/start/command.d.ts.map +1 -1
  31. package/dist/commonjs/mcp-server/cli/start/command.js +0 -104
  32. package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
  33. package/dist/commonjs/mcp-server/cli/start/impl.d.ts +0 -13
  34. package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
  35. package/dist/commonjs/mcp-server/cli/start/impl.js +0 -26
  36. package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -1
  37. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  38. package/dist/commonjs/mcp-server/server.js +1 -1
  39. package/dist/commonjs/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
  40. package/dist/commonjs/mcp-server/tools/actions-cancel-action.js +1 -17
  41. package/dist/commonjs/mcp-server/tools/actions-cancel-action.js.map +1 -1
  42. package/dist/commonjs/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
  43. package/dist/commonjs/mcp-server/tools/actions-check-action-status.js +1 -17
  44. package/dist/commonjs/mcp-server/tools/actions-check-action-status.js.map +1 -1
  45. package/dist/commonjs/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
  46. package/dist/commonjs/mcp-server/tools/actions-propose-action.js +1 -17
  47. package/dist/commonjs/mcp-server/tools/actions-propose-action.js.map +1 -1
  48. package/dist/commonjs/models/error-body.d.ts +43 -8
  49. package/dist/commonjs/models/error-body.d.ts.map +1 -1
  50. package/dist/commonjs/models/error-body.js +51 -1
  51. package/dist/commonjs/models/error-body.js.map +1 -1
  52. package/dist/commonjs/models/operations/actions-cancel.d.ts +1 -1
  53. package/dist/commonjs/models/operations/actions-check-status.d.ts +6 -6
  54. package/dist/commonjs/models/operations/actions-check-status.d.ts.map +1 -1
  55. package/dist/commonjs/models/operations/actions-check-status.js +6 -6
  56. package/dist/commonjs/models/operations/actions-check-status.js.map +1 -1
  57. package/dist/commonjs/models/operations/actions-propose.d.ts +1 -1
  58. package/dist/commonjs/models/operations/index.d.ts +3 -0
  59. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  60. package/dist/commonjs/models/operations/index.js +3 -0
  61. package/dist/commonjs/models/operations/index.js.map +1 -1
  62. package/dist/commonjs/models/operations/sdk-create-session.d.ts +44 -10
  63. package/dist/commonjs/models/operations/sdk-create-session.d.ts.map +1 -1
  64. package/dist/commonjs/models/operations/sdk-create-session.js +32 -11
  65. package/dist/commonjs/models/operations/sdk-create-session.js.map +1 -1
  66. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +96 -2
  67. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  68. package/dist/commonjs/models/operations/sdk-create-verification-link.js +58 -1
  69. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  70. package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +23 -27
  71. package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts.map +1 -1
  72. package/dist/commonjs/models/operations/sdk-get-partner-config.js +18 -26
  73. package/dist/commonjs/models/operations/sdk-get-partner-config.js.map +1 -1
  74. package/dist/commonjs/models/operations/sdk-logout.d.ts +1 -1
  75. package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts +14 -4
  76. package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts.map +1 -1
  77. package/dist/commonjs/models/operations/sdk-revoke-verification.js +4 -2
  78. package/dist/commonjs/models/operations/sdk-revoke-verification.js.map +1 -1
  79. package/dist/commonjs/models/operations/sdk-store-signal.d.ts +1 -1
  80. package/dist/commonjs/models/operations/sdk-validate-signal.d.ts +6 -6
  81. package/dist/commonjs/models/operations/sdk-validate-signal.d.ts.map +1 -1
  82. package/dist/commonjs/models/operations/sdk-validate-signal.js +6 -6
  83. package/dist/commonjs/models/operations/sdk-validate-signal.js.map +1 -1
  84. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +78 -27
  85. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  86. package/dist/commonjs/models/operations/sdk-verify-token.js +51 -27
  87. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  88. package/dist/commonjs/models/operations/secured-accounts-list.d.ts +212 -0
  89. package/dist/commonjs/models/operations/secured-accounts-list.d.ts.map +1 -0
  90. package/dist/commonjs/models/operations/secured-accounts-list.js +254 -0
  91. package/dist/commonjs/models/operations/secured-accounts-list.js.map +1 -0
  92. package/dist/commonjs/models/operations/secured-accounts-revoke.d.ts +130 -0
  93. package/dist/commonjs/models/operations/secured-accounts-revoke.d.ts.map +1 -0
  94. package/dist/commonjs/models/operations/secured-accounts-revoke.js +185 -0
  95. package/dist/commonjs/models/operations/secured-accounts-revoke.js.map +1 -0
  96. package/dist/commonjs/models/operations/secured-accounts-status.d.ts +97 -0
  97. package/dist/commonjs/models/operations/secured-accounts-status.d.ts.map +1 -0
  98. package/dist/commonjs/models/operations/secured-accounts-status.js +163 -0
  99. package/dist/commonjs/models/operations/secured-accounts-status.js.map +1 -0
  100. package/dist/commonjs/models/operations/verification-get-status.d.ts +47 -30
  101. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  102. package/dist/commonjs/models/operations/verification-get-status.js +30 -28
  103. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  104. package/dist/commonjs/models/security.d.ts +0 -26
  105. package/dist/commonjs/models/security.d.ts.map +1 -1
  106. package/dist/commonjs/models/security.js +0 -26
  107. package/dist/commonjs/models/security.js.map +1 -1
  108. package/dist/commonjs/sdk/actions.d.ts +1 -1
  109. package/dist/commonjs/sdk/actions.js +1 -1
  110. package/dist/commonjs/sdk/census.d.ts +1 -1
  111. package/dist/commonjs/sdk/census.js +1 -1
  112. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  113. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  114. package/dist/commonjs/sdk/sdk.js +5 -0
  115. package/dist/commonjs/sdk/sdk.js.map +1 -1
  116. package/dist/commonjs/sdk/secured-accounts.d.ts +26 -0
  117. package/dist/commonjs/sdk/secured-accounts.d.ts.map +1 -0
  118. package/dist/commonjs/sdk/secured-accounts.js +42 -0
  119. package/dist/commonjs/sdk/secured-accounts.js.map +1 -0
  120. package/dist/esm/funcs/actions-propose-action.d.ts +1 -1
  121. package/dist/esm/funcs/actions-propose-action.js +1 -1
  122. package/dist/esm/funcs/census-get-partner-config.js +2 -78
  123. package/dist/esm/funcs/census-get-partner-config.js.map +1 -1
  124. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  125. package/dist/esm/funcs/census-verify-token.js +1 -79
  126. package/dist/esm/funcs/census-verify-token.js.map +1 -1
  127. package/dist/esm/funcs/secured-accounts-get-status.d.ts +18 -0
  128. package/dist/esm/funcs/secured-accounts-get-status.d.ts.map +1 -0
  129. package/dist/esm/funcs/secured-accounts-get-status.js +90 -0
  130. package/dist/esm/funcs/secured-accounts-get-status.js.map +1 -0
  131. package/dist/esm/funcs/secured-accounts-list.d.ts +18 -0
  132. package/dist/esm/funcs/secured-accounts-list.d.ts.map +1 -0
  133. package/dist/esm/funcs/secured-accounts-list.js +93 -0
  134. package/dist/esm/funcs/secured-accounts-list.js.map +1 -0
  135. package/dist/esm/funcs/secured-accounts-revoke.d.ts +18 -0
  136. package/dist/esm/funcs/secured-accounts-revoke.d.ts.map +1 -0
  137. package/dist/esm/funcs/secured-accounts-revoke.js +87 -0
  138. package/dist/esm/funcs/secured-accounts-revoke.js.map +1 -0
  139. package/dist/esm/funcs/verification-get-status.js +0 -78
  140. package/dist/esm/funcs/verification-get-status.js.map +1 -1
  141. package/dist/esm/lib/config.d.ts +2 -2
  142. package/dist/esm/lib/config.js +2 -2
  143. package/dist/esm/lib/security.d.ts.map +1 -1
  144. package/dist/esm/lib/security.js +0 -91
  145. package/dist/esm/lib/security.js.map +1 -1
  146. package/dist/esm/mcp-server/cli/start/command.d.ts.map +1 -1
  147. package/dist/esm/mcp-server/cli/start/command.js +0 -104
  148. package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
  149. package/dist/esm/mcp-server/cli/start/impl.d.ts +0 -13
  150. package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
  151. package/dist/esm/mcp-server/cli/start/impl.js +0 -26
  152. package/dist/esm/mcp-server/cli/start/impl.js.map +1 -1
  153. package/dist/esm/mcp-server/mcp-server.js +1 -1
  154. package/dist/esm/mcp-server/server.js +1 -1
  155. package/dist/esm/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
  156. package/dist/esm/mcp-server/tools/actions-cancel-action.js +1 -17
  157. package/dist/esm/mcp-server/tools/actions-cancel-action.js.map +1 -1
  158. package/dist/esm/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
  159. package/dist/esm/mcp-server/tools/actions-check-action-status.js +1 -17
  160. package/dist/esm/mcp-server/tools/actions-check-action-status.js.map +1 -1
  161. package/dist/esm/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
  162. package/dist/esm/mcp-server/tools/actions-propose-action.js +1 -17
  163. package/dist/esm/mcp-server/tools/actions-propose-action.js.map +1 -1
  164. package/dist/esm/models/error-body.d.ts +43 -8
  165. package/dist/esm/models/error-body.d.ts.map +1 -1
  166. package/dist/esm/models/error-body.js +48 -0
  167. package/dist/esm/models/error-body.js.map +1 -1
  168. package/dist/esm/models/operations/actions-cancel.d.ts +1 -1
  169. package/dist/esm/models/operations/actions-check-status.d.ts +6 -6
  170. package/dist/esm/models/operations/actions-check-status.d.ts.map +1 -1
  171. package/dist/esm/models/operations/actions-check-status.js +5 -5
  172. package/dist/esm/models/operations/actions-check-status.js.map +1 -1
  173. package/dist/esm/models/operations/actions-propose.d.ts +1 -1
  174. package/dist/esm/models/operations/index.d.ts +3 -0
  175. package/dist/esm/models/operations/index.d.ts.map +1 -1
  176. package/dist/esm/models/operations/index.js +3 -0
  177. package/dist/esm/models/operations/index.js.map +1 -1
  178. package/dist/esm/models/operations/sdk-create-session.d.ts +44 -10
  179. package/dist/esm/models/operations/sdk-create-session.d.ts.map +1 -1
  180. package/dist/esm/models/operations/sdk-create-session.js +29 -8
  181. package/dist/esm/models/operations/sdk-create-session.js.map +1 -1
  182. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +96 -2
  183. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  184. package/dist/esm/models/operations/sdk-create-verification-link.js +57 -0
  185. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  186. package/dist/esm/models/operations/sdk-get-partner-config.d.ts +23 -27
  187. package/dist/esm/models/operations/sdk-get-partner-config.d.ts.map +1 -1
  188. package/dist/esm/models/operations/sdk-get-partner-config.js +18 -26
  189. package/dist/esm/models/operations/sdk-get-partner-config.js.map +1 -1
  190. package/dist/esm/models/operations/sdk-logout.d.ts +1 -1
  191. package/dist/esm/models/operations/sdk-revoke-verification.d.ts +14 -4
  192. package/dist/esm/models/operations/sdk-revoke-verification.d.ts.map +1 -1
  193. package/dist/esm/models/operations/sdk-revoke-verification.js +4 -2
  194. package/dist/esm/models/operations/sdk-revoke-verification.js.map +1 -1
  195. package/dist/esm/models/operations/sdk-store-signal.d.ts +1 -1
  196. package/dist/esm/models/operations/sdk-validate-signal.d.ts +6 -6
  197. package/dist/esm/models/operations/sdk-validate-signal.d.ts.map +1 -1
  198. package/dist/esm/models/operations/sdk-validate-signal.js +5 -5
  199. package/dist/esm/models/operations/sdk-validate-signal.js.map +1 -1
  200. package/dist/esm/models/operations/sdk-verify-token.d.ts +78 -27
  201. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  202. package/dist/esm/models/operations/sdk-verify-token.js +50 -26
  203. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  204. package/dist/esm/models/operations/secured-accounts-list.d.ts +212 -0
  205. package/dist/esm/models/operations/secured-accounts-list.d.ts.map +1 -0
  206. package/dist/esm/models/operations/secured-accounts-list.js +206 -0
  207. package/dist/esm/models/operations/secured-accounts-list.js.map +1 -0
  208. package/dist/esm/models/operations/secured-accounts-revoke.d.ts +130 -0
  209. package/dist/esm/models/operations/secured-accounts-revoke.d.ts.map +1 -0
  210. package/dist/esm/models/operations/secured-accounts-revoke.js +139 -0
  211. package/dist/esm/models/operations/secured-accounts-revoke.js.map +1 -0
  212. package/dist/esm/models/operations/secured-accounts-status.d.ts +97 -0
  213. package/dist/esm/models/operations/secured-accounts-status.d.ts.map +1 -0
  214. package/dist/esm/models/operations/secured-accounts-status.js +117 -0
  215. package/dist/esm/models/operations/secured-accounts-status.js.map +1 -0
  216. package/dist/esm/models/operations/verification-get-status.d.ts +47 -30
  217. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  218. package/dist/esm/models/operations/verification-get-status.js +29 -27
  219. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  220. package/dist/esm/models/security.d.ts +0 -26
  221. package/dist/esm/models/security.d.ts.map +1 -1
  222. package/dist/esm/models/security.js +0 -26
  223. package/dist/esm/models/security.js.map +1 -1
  224. package/dist/esm/sdk/actions.d.ts +1 -1
  225. package/dist/esm/sdk/actions.js +1 -1
  226. package/dist/esm/sdk/census.d.ts +1 -1
  227. package/dist/esm/sdk/census.js +1 -1
  228. package/dist/esm/sdk/sdk.d.ts +3 -0
  229. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  230. package/dist/esm/sdk/sdk.js +5 -0
  231. package/dist/esm/sdk/sdk.js.map +1 -1
  232. package/dist/esm/sdk/secured-accounts.d.ts +26 -0
  233. package/dist/esm/sdk/secured-accounts.d.ts.map +1 -0
  234. package/dist/esm/sdk/secured-accounts.js +38 -0
  235. package/dist/esm/sdk/secured-accounts.js.map +1 -0
  236. package/jsr.json +1 -1
  237. package/package.json +1 -1
  238. package/src/funcs/actions-propose-action.ts +1 -1
  239. package/src/funcs/census-get-partner-config.ts +2 -91
  240. package/src/funcs/census-verify-token.ts +1 -92
  241. package/src/funcs/secured-accounts-get-status.ts +189 -0
  242. package/src/funcs/secured-accounts-list.ts +194 -0
  243. package/src/funcs/secured-accounts-revoke.ts +185 -0
  244. package/src/funcs/verification-get-status.ts +0 -91
  245. package/src/lib/config.ts +2 -2
  246. package/src/lib/security.ts +0 -91
  247. package/src/mcp-server/cli/start/command.ts +0 -104
  248. package/src/mcp-server/cli/start/impl.ts +0 -39
  249. package/src/mcp-server/mcp-server.ts +1 -1
  250. package/src/mcp-server/server.ts +1 -1
  251. package/src/mcp-server/tools/actions-cancel-action.ts +1 -17
  252. package/src/mcp-server/tools/actions-check-action-status.ts +1 -17
  253. package/src/mcp-server/tools/actions-propose-action.ts +1 -17
  254. package/src/models/error-body.ts +95 -8
  255. package/src/models/operations/actions-cancel.ts +1 -1
  256. package/src/models/operations/actions-check-status.ts +18 -10
  257. package/src/models/operations/actions-propose.ts +1 -1
  258. package/src/models/operations/index.ts +3 -0
  259. package/src/models/operations/sdk-create-session.ts +78 -20
  260. package/src/models/operations/sdk-create-verification-link.ts +157 -2
  261. package/src/models/operations/sdk-get-partner-config.ts +41 -53
  262. package/src/models/operations/sdk-logout.ts +1 -1
  263. package/src/models/operations/sdk-revoke-verification.ts +18 -6
  264. package/src/models/operations/sdk-store-signal.ts +1 -1
  265. package/src/models/operations/sdk-validate-signal.ts +16 -10
  266. package/src/models/operations/sdk-verify-token.ts +119 -53
  267. package/src/models/operations/secured-accounts-list.ts +507 -0
  268. package/src/models/operations/secured-accounts-revoke.ts +359 -0
  269. package/src/models/operations/secured-accounts-status.ts +296 -0
  270. package/src/models/operations/verification-get-status.ts +73 -56
  271. package/src/models/security.ts +0 -52
  272. package/src/sdk/actions.ts +1 -1
  273. package/src/sdk/census.ts +1 -1
  274. package/src/sdk/sdk.ts +6 -0
  275. package/src/sdk/secured-accounts.ts +69 -0
@@ -0,0 +1,507 @@
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 SecuredAccountsListSecurity = {
16
+ apiKeyAuth: string;
17
+ };
18
+
19
+ /**
20
+ * Omit for both.
21
+ */
22
+ export const QueryParamStatus = {
23
+ Active: "active",
24
+ Unlinked: "unlinked",
25
+ } as const;
26
+ /**
27
+ * Omit for both.
28
+ */
29
+ export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
30
+
31
+ export type SecuredAccountsListRequest = {
32
+ /**
33
+ * Your stable user id for the account (the same `platform_user_ref` you passed when it was secured). Hashed server-side; never stored or returned.
34
+ */
35
+ platformUserRef?: string | undefined;
36
+ /**
37
+ * Omit for both.
38
+ */
39
+ status?: QueryParamStatus | undefined;
40
+ /**
41
+ * Page size. Default 25, max 100.
42
+ */
43
+ limit?: number | undefined;
44
+ /**
45
+ * Default 0.
46
+ */
47
+ offset?: number | undefined;
48
+ };
49
+
50
+ export const RowStatus = {
51
+ Active: "active",
52
+ Unlinked: "unlinked",
53
+ } as const;
54
+ export type RowStatus = OpenEnum<typeof RowStatus>;
55
+
56
+ export const UnlinkedBy = {
57
+ Platform: "platform",
58
+ Human: "human",
59
+ } as const;
60
+ export type UnlinkedBy = OpenEnum<typeof UnlinkedBy>;
61
+
62
+ /**
63
+ * Why it ended: `credential_changed` (you reported a sign-in detail changed), `platform` (you revoked it), `human` (the person unlinked it). null while active.
64
+ */
65
+ export const SecuredAccountsListUnlinkReason = {
66
+ CredentialChanged: "credential_changed",
67
+ Platform: "platform",
68
+ Human: "human",
69
+ } as const;
70
+ /**
71
+ * Why it ended: `credential_changed` (you reported a sign-in detail changed), `platform` (you revoked it), `human` (the person unlinked it). null while active.
72
+ */
73
+ export type SecuredAccountsListUnlinkReason = OpenEnum<
74
+ typeof SecuredAccountsListUnlinkReason
75
+ >;
76
+
77
+ export type Row = {
78
+ /**
79
+ * The Secured Account handle — your per-platform reference for the person, the same value carried on `account.secured` / `account.unlinked`.
80
+ */
81
+ handle: string;
82
+ status: RowStatus;
83
+ /**
84
+ * When the person secured the account.
85
+ */
86
+ securedAt: Date;
87
+ unlinkedAt: Date | null;
88
+ unlinkedBy: UnlinkedBy | null;
89
+ /**
90
+ * Why it ended: `credential_changed` (you reported a sign-in detail changed), `platform` (you revoked it), `human` (the person unlinked it). null while active.
91
+ */
92
+ unlinkReason: SecuredAccountsListUnlinkReason | null;
93
+ /**
94
+ * The Link with BotShield ID surface the account was secured through; null when it was secured at a Gate.
95
+ */
96
+ surfaceId: string | null;
97
+ };
98
+
99
+ /**
100
+ * Your API key's environment.
101
+ */
102
+ export const SecuredAccountsListEnvironment = {
103
+ Development: "development",
104
+ Production: "production",
105
+ } as const;
106
+ /**
107
+ * Your API key's environment.
108
+ */
109
+ export type SecuredAccountsListEnvironment = OpenEnum<
110
+ typeof SecuredAccountsListEnvironment
111
+ >;
112
+
113
+ export type SecuredAccountsListDataData = {
114
+ rows: Array<Row>;
115
+ /**
116
+ * Matching rows across all pages.
117
+ */
118
+ total: number;
119
+ /**
120
+ * Your API key's environment.
121
+ */
122
+ environment: SecuredAccountsListEnvironment;
123
+ limit: number;
124
+ offset: number;
125
+ };
126
+
127
+ export type SecuredAccountsListData = {
128
+ data?: SecuredAccountsListDataData | undefined;
129
+ /**
130
+ * Handler error. Arrives inside `data.error` with HTTP 200. Check for it before reading the result.
131
+ */
132
+ error?: models.ErrorBody | undefined;
133
+ };
134
+
135
+ /**
136
+ * One page of Secured Accounts. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `api_key_required` / `invalid_api_key` (401), `partner_not_found` (403), `invalid_platform_user_ref` / `invalid_status` (400), `secured_accounts_unavailable` (500).
137
+ */
138
+ export type SecuredAccountsListResponse = {
139
+ data: SecuredAccountsListData;
140
+ };
141
+
142
+ /** @internal */
143
+ export const SecuredAccountsListSecurity$inboundSchema: z.ZodType<
144
+ SecuredAccountsListSecurity,
145
+ z.ZodTypeDef,
146
+ unknown
147
+ > = z.object({
148
+ ApiKeyAuth: types.string(),
149
+ }).transform((v) => {
150
+ return remap$(v, {
151
+ "ApiKeyAuth": "apiKeyAuth",
152
+ });
153
+ });
154
+ /** @internal */
155
+ export type SecuredAccountsListSecurity$Outbound = {
156
+ ApiKeyAuth: string;
157
+ };
158
+
159
+ /** @internal */
160
+ export const SecuredAccountsListSecurity$outboundSchema: z.ZodType<
161
+ SecuredAccountsListSecurity$Outbound,
162
+ z.ZodTypeDef,
163
+ SecuredAccountsListSecurity
164
+ > = z.object({
165
+ apiKeyAuth: z.string(),
166
+ }).transform((v) => {
167
+ return remap$(v, {
168
+ apiKeyAuth: "ApiKeyAuth",
169
+ });
170
+ });
171
+
172
+ export function securedAccountsListSecurityToJSON(
173
+ securedAccountsListSecurity: SecuredAccountsListSecurity,
174
+ ): string {
175
+ return JSON.stringify(
176
+ SecuredAccountsListSecurity$outboundSchema.parse(
177
+ securedAccountsListSecurity,
178
+ ),
179
+ );
180
+ }
181
+ export function securedAccountsListSecurityFromJSON(
182
+ jsonString: string,
183
+ ): SafeParseResult<SecuredAccountsListSecurity, SDKValidationError> {
184
+ return safeParse(
185
+ jsonString,
186
+ (x) => SecuredAccountsListSecurity$inboundSchema.parse(JSON.parse(x)),
187
+ `Failed to parse 'SecuredAccountsListSecurity' from JSON`,
188
+ );
189
+ }
190
+
191
+ /** @internal */
192
+ export const QueryParamStatus$inboundSchema: z.ZodNativeEnum<
193
+ typeof QueryParamStatus
194
+ > = z.nativeEnum(QueryParamStatus);
195
+ /** @internal */
196
+ export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
197
+ typeof QueryParamStatus
198
+ > = QueryParamStatus$inboundSchema;
199
+
200
+ /** @internal */
201
+ export const SecuredAccountsListRequest$inboundSchema: z.ZodType<
202
+ SecuredAccountsListRequest,
203
+ z.ZodTypeDef,
204
+ unknown
205
+ > = z.object({
206
+ platform_user_ref: types.optional(types.string()),
207
+ status: types.optional(QueryParamStatus$inboundSchema),
208
+ limit: types.optional(types.number()),
209
+ offset: types.optional(types.number()),
210
+ }).transform((v) => {
211
+ return remap$(v, {
212
+ "platform_user_ref": "platformUserRef",
213
+ });
214
+ });
215
+ /** @internal */
216
+ export type SecuredAccountsListRequest$Outbound = {
217
+ platform_user_ref?: string | undefined;
218
+ status?: string | undefined;
219
+ limit?: number | undefined;
220
+ offset?: number | undefined;
221
+ };
222
+
223
+ /** @internal */
224
+ export const SecuredAccountsListRequest$outboundSchema: z.ZodType<
225
+ SecuredAccountsListRequest$Outbound,
226
+ z.ZodTypeDef,
227
+ SecuredAccountsListRequest
228
+ > = z.object({
229
+ platformUserRef: z.string().optional(),
230
+ status: QueryParamStatus$outboundSchema.optional(),
231
+ limit: z.number().int().optional(),
232
+ offset: z.number().int().optional(),
233
+ }).transform((v) => {
234
+ return remap$(v, {
235
+ platformUserRef: "platform_user_ref",
236
+ });
237
+ });
238
+
239
+ export function securedAccountsListRequestToJSON(
240
+ securedAccountsListRequest: SecuredAccountsListRequest,
241
+ ): string {
242
+ return JSON.stringify(
243
+ SecuredAccountsListRequest$outboundSchema.parse(securedAccountsListRequest),
244
+ );
245
+ }
246
+ export function securedAccountsListRequestFromJSON(
247
+ jsonString: string,
248
+ ): SafeParseResult<SecuredAccountsListRequest, SDKValidationError> {
249
+ return safeParse(
250
+ jsonString,
251
+ (x) => SecuredAccountsListRequest$inboundSchema.parse(JSON.parse(x)),
252
+ `Failed to parse 'SecuredAccountsListRequest' from JSON`,
253
+ );
254
+ }
255
+
256
+ /** @internal */
257
+ export const RowStatus$inboundSchema: z.ZodType<
258
+ RowStatus,
259
+ z.ZodTypeDef,
260
+ unknown
261
+ > = openEnums.inboundSchema(RowStatus);
262
+ /** @internal */
263
+ export const RowStatus$outboundSchema: z.ZodType<
264
+ string,
265
+ z.ZodTypeDef,
266
+ RowStatus
267
+ > = openEnums.outboundSchema(RowStatus);
268
+
269
+ /** @internal */
270
+ export const UnlinkedBy$inboundSchema: z.ZodType<
271
+ UnlinkedBy,
272
+ z.ZodTypeDef,
273
+ unknown
274
+ > = openEnums.inboundSchema(UnlinkedBy);
275
+ /** @internal */
276
+ export const UnlinkedBy$outboundSchema: z.ZodType<
277
+ string,
278
+ z.ZodTypeDef,
279
+ UnlinkedBy
280
+ > = openEnums.outboundSchema(UnlinkedBy);
281
+
282
+ /** @internal */
283
+ export const SecuredAccountsListUnlinkReason$inboundSchema: z.ZodType<
284
+ SecuredAccountsListUnlinkReason,
285
+ z.ZodTypeDef,
286
+ unknown
287
+ > = openEnums.inboundSchema(SecuredAccountsListUnlinkReason);
288
+ /** @internal */
289
+ export const SecuredAccountsListUnlinkReason$outboundSchema: z.ZodType<
290
+ string,
291
+ z.ZodTypeDef,
292
+ SecuredAccountsListUnlinkReason
293
+ > = openEnums.outboundSchema(SecuredAccountsListUnlinkReason);
294
+
295
+ /** @internal */
296
+ export const Row$inboundSchema: z.ZodType<Row, z.ZodTypeDef, unknown> = z
297
+ .object({
298
+ handle: types.string(),
299
+ status: RowStatus$inboundSchema,
300
+ secured_at: types.date(),
301
+ unlinked_at: types.nullable(types.date()),
302
+ unlinked_by: types.nullable(UnlinkedBy$inboundSchema),
303
+ unlink_reason: types.nullable(
304
+ SecuredAccountsListUnlinkReason$inboundSchema,
305
+ ),
306
+ surface_id: types.nullable(types.string()),
307
+ }).transform((v) => {
308
+ return remap$(v, {
309
+ "secured_at": "securedAt",
310
+ "unlinked_at": "unlinkedAt",
311
+ "unlinked_by": "unlinkedBy",
312
+ "unlink_reason": "unlinkReason",
313
+ "surface_id": "surfaceId",
314
+ });
315
+ });
316
+ /** @internal */
317
+ export type Row$Outbound = {
318
+ handle: string;
319
+ status: string;
320
+ secured_at: string;
321
+ unlinked_at: string | null;
322
+ unlinked_by: string | null;
323
+ unlink_reason: string | null;
324
+ surface_id: string | null;
325
+ };
326
+
327
+ /** @internal */
328
+ export const Row$outboundSchema: z.ZodType<Row$Outbound, z.ZodTypeDef, Row> = z
329
+ .object({
330
+ handle: z.string(),
331
+ status: RowStatus$outboundSchema,
332
+ securedAt: z.date().transform(v => v.toISOString()),
333
+ unlinkedAt: z.nullable(z.date().transform(v => v.toISOString())),
334
+ unlinkedBy: z.nullable(UnlinkedBy$outboundSchema),
335
+ unlinkReason: z.nullable(SecuredAccountsListUnlinkReason$outboundSchema),
336
+ surfaceId: z.nullable(z.string()),
337
+ }).transform((v) => {
338
+ return remap$(v, {
339
+ securedAt: "secured_at",
340
+ unlinkedAt: "unlinked_at",
341
+ unlinkedBy: "unlinked_by",
342
+ unlinkReason: "unlink_reason",
343
+ surfaceId: "surface_id",
344
+ });
345
+ });
346
+
347
+ export function rowToJSON(row: Row): string {
348
+ return JSON.stringify(Row$outboundSchema.parse(row));
349
+ }
350
+ export function rowFromJSON(
351
+ jsonString: string,
352
+ ): SafeParseResult<Row, SDKValidationError> {
353
+ return safeParse(
354
+ jsonString,
355
+ (x) => Row$inboundSchema.parse(JSON.parse(x)),
356
+ `Failed to parse 'Row' from JSON`,
357
+ );
358
+ }
359
+
360
+ /** @internal */
361
+ export const SecuredAccountsListEnvironment$inboundSchema: z.ZodType<
362
+ SecuredAccountsListEnvironment,
363
+ z.ZodTypeDef,
364
+ unknown
365
+ > = openEnums.inboundSchema(SecuredAccountsListEnvironment);
366
+ /** @internal */
367
+ export const SecuredAccountsListEnvironment$outboundSchema: z.ZodType<
368
+ string,
369
+ z.ZodTypeDef,
370
+ SecuredAccountsListEnvironment
371
+ > = openEnums.outboundSchema(SecuredAccountsListEnvironment);
372
+
373
+ /** @internal */
374
+ export const SecuredAccountsListDataData$inboundSchema: z.ZodType<
375
+ SecuredAccountsListDataData,
376
+ z.ZodTypeDef,
377
+ unknown
378
+ > = z.object({
379
+ rows: z.array(z.lazy(() => Row$inboundSchema)),
380
+ total: types.number(),
381
+ environment: SecuredAccountsListEnvironment$inboundSchema,
382
+ limit: types.number(),
383
+ offset: types.number(),
384
+ });
385
+ /** @internal */
386
+ export type SecuredAccountsListDataData$Outbound = {
387
+ rows: Array<Row$Outbound>;
388
+ total: number;
389
+ environment: string;
390
+ limit: number;
391
+ offset: number;
392
+ };
393
+
394
+ /** @internal */
395
+ export const SecuredAccountsListDataData$outboundSchema: z.ZodType<
396
+ SecuredAccountsListDataData$Outbound,
397
+ z.ZodTypeDef,
398
+ SecuredAccountsListDataData
399
+ > = z.object({
400
+ rows: z.array(z.lazy(() => Row$outboundSchema)),
401
+ total: z.number().int(),
402
+ environment: SecuredAccountsListEnvironment$outboundSchema,
403
+ limit: z.number().int(),
404
+ offset: z.number().int(),
405
+ });
406
+
407
+ export function securedAccountsListDataDataToJSON(
408
+ securedAccountsListDataData: SecuredAccountsListDataData,
409
+ ): string {
410
+ return JSON.stringify(
411
+ SecuredAccountsListDataData$outboundSchema.parse(
412
+ securedAccountsListDataData,
413
+ ),
414
+ );
415
+ }
416
+ export function securedAccountsListDataDataFromJSON(
417
+ jsonString: string,
418
+ ): SafeParseResult<SecuredAccountsListDataData, SDKValidationError> {
419
+ return safeParse(
420
+ jsonString,
421
+ (x) => SecuredAccountsListDataData$inboundSchema.parse(JSON.parse(x)),
422
+ `Failed to parse 'SecuredAccountsListDataData' from JSON`,
423
+ );
424
+ }
425
+
426
+ /** @internal */
427
+ export const SecuredAccountsListData$inboundSchema: z.ZodType<
428
+ SecuredAccountsListData,
429
+ z.ZodTypeDef,
430
+ unknown
431
+ > = z.object({
432
+ data: types.optional(z.lazy(() => SecuredAccountsListDataData$inboundSchema)),
433
+ error: types.optional(models.ErrorBody$inboundSchema),
434
+ });
435
+ /** @internal */
436
+ export type SecuredAccountsListData$Outbound = {
437
+ data?: SecuredAccountsListDataData$Outbound | undefined;
438
+ error?: models.ErrorBody$Outbound | undefined;
439
+ };
440
+
441
+ /** @internal */
442
+ export const SecuredAccountsListData$outboundSchema: z.ZodType<
443
+ SecuredAccountsListData$Outbound,
444
+ z.ZodTypeDef,
445
+ SecuredAccountsListData
446
+ > = z.object({
447
+ data: z.lazy(() => SecuredAccountsListDataData$outboundSchema).optional(),
448
+ error: models.ErrorBody$outboundSchema.optional(),
449
+ });
450
+
451
+ export function securedAccountsListDataToJSON(
452
+ securedAccountsListData: SecuredAccountsListData,
453
+ ): string {
454
+ return JSON.stringify(
455
+ SecuredAccountsListData$outboundSchema.parse(securedAccountsListData),
456
+ );
457
+ }
458
+ export function securedAccountsListDataFromJSON(
459
+ jsonString: string,
460
+ ): SafeParseResult<SecuredAccountsListData, SDKValidationError> {
461
+ return safeParse(
462
+ jsonString,
463
+ (x) => SecuredAccountsListData$inboundSchema.parse(JSON.parse(x)),
464
+ `Failed to parse 'SecuredAccountsListData' from JSON`,
465
+ );
466
+ }
467
+
468
+ /** @internal */
469
+ export const SecuredAccountsListResponse$inboundSchema: z.ZodType<
470
+ SecuredAccountsListResponse,
471
+ z.ZodTypeDef,
472
+ unknown
473
+ > = z.object({
474
+ data: z.lazy(() => SecuredAccountsListData$inboundSchema),
475
+ });
476
+ /** @internal */
477
+ export type SecuredAccountsListResponse$Outbound = {
478
+ data: SecuredAccountsListData$Outbound;
479
+ };
480
+
481
+ /** @internal */
482
+ export const SecuredAccountsListResponse$outboundSchema: z.ZodType<
483
+ SecuredAccountsListResponse$Outbound,
484
+ z.ZodTypeDef,
485
+ SecuredAccountsListResponse
486
+ > = z.object({
487
+ data: z.lazy(() => SecuredAccountsListData$outboundSchema),
488
+ });
489
+
490
+ export function securedAccountsListResponseToJSON(
491
+ securedAccountsListResponse: SecuredAccountsListResponse,
492
+ ): string {
493
+ return JSON.stringify(
494
+ SecuredAccountsListResponse$outboundSchema.parse(
495
+ securedAccountsListResponse,
496
+ ),
497
+ );
498
+ }
499
+ export function securedAccountsListResponseFromJSON(
500
+ jsonString: string,
501
+ ): SafeParseResult<SecuredAccountsListResponse, SDKValidationError> {
502
+ return safeParse(
503
+ jsonString,
504
+ (x) => SecuredAccountsListResponse$inboundSchema.parse(JSON.parse(x)),
505
+ `Failed to parse 'SecuredAccountsListResponse' from JSON`,
506
+ );
507
+ }