rehive 4.2.0 → 4.2.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 (274) hide show
  1. package/README.md +17 -0
  2. package/dist/admin.d.mts +614 -116
  3. package/dist/admin.d.ts +614 -116
  4. package/dist/admin.js +1 -1
  5. package/dist/admin.mjs +1 -1
  6. package/dist/auth.d.mts +2 -2
  7. package/dist/auth.d.ts +2 -2
  8. package/dist/auth.js +1 -1
  9. package/dist/auth.mjs +1 -1
  10. package/dist/{chunk-PCR54D6A.mjs → chunk-A53KSFBA.mjs} +1 -1
  11. package/dist/chunk-CRNPJD3E.js +6 -0
  12. package/dist/{chunk-ERD2XKSM.js → chunk-HXAEBUQM.js} +1 -1
  13. package/dist/chunk-IJBXROTB.mjs +6 -0
  14. package/dist/chunk-OV77OD2G.js +1 -0
  15. package/dist/chunk-RO2QGTSG.mjs +1 -0
  16. package/dist/chunk-TAABJLJG.mjs +6 -0
  17. package/dist/chunk-Y33FT632.js +6 -0
  18. package/dist/{create-api-client-B4Q01gHp.d.mts → create-api-client-Bkkri-AM.d.mts} +1 -1
  19. package/dist/{create-api-client-ADSlg8HX.d.ts → create-api-client-CgvKBlQ_.d.ts} +1 -1
  20. package/dist/{create-auth-CT_IFt3T.d.mts → create-auth-ChOASbvo.d.mts} +111 -100
  21. package/dist/{create-auth-CT_IFt3T.d.ts → create-auth-ChOASbvo.d.ts} +111 -100
  22. package/dist/extensions/alchemy.d.mts +175 -41
  23. package/dist/extensions/alchemy.d.ts +175 -41
  24. package/dist/extensions/alchemy.js +5 -6
  25. package/dist/extensions/alchemy.mjs +5 -6
  26. package/dist/extensions/app.d.mts +11 -10
  27. package/dist/extensions/app.d.ts +11 -10
  28. package/dist/extensions/app.js +5 -6
  29. package/dist/extensions/app.mjs +5 -6
  30. package/dist/extensions/billing.d.mts +11 -10
  31. package/dist/extensions/billing.d.ts +11 -10
  32. package/dist/extensions/billing.js +5 -6
  33. package/dist/extensions/billing.mjs +5 -6
  34. package/dist/extensions/bridge.d.mts +537 -38
  35. package/dist/extensions/bridge.d.ts +537 -38
  36. package/dist/extensions/bridge.js +5 -6
  37. package/dist/extensions/bridge.mjs +5 -6
  38. package/dist/extensions/builder.d.mts +8 -7
  39. package/dist/extensions/builder.d.ts +8 -7
  40. package/dist/extensions/builder.js +5 -6
  41. package/dist/extensions/builder.mjs +5 -6
  42. package/dist/extensions/business.d.mts +99 -63
  43. package/dist/extensions/business.d.ts +99 -63
  44. package/dist/extensions/business.js +5 -6
  45. package/dist/extensions/business.mjs +5 -6
  46. package/dist/extensions/conversion.d.mts +10 -9
  47. package/dist/extensions/conversion.d.ts +10 -9
  48. package/dist/extensions/conversion.js +5 -6
  49. package/dist/extensions/conversion.mjs +5 -6
  50. package/dist/extensions/mass-send.d.mts +8 -7
  51. package/dist/extensions/mass-send.d.ts +8 -7
  52. package/dist/extensions/mass-send.js +5 -6
  53. package/dist/extensions/mass-send.mjs +5 -6
  54. package/dist/extensions/notifications.d.mts +16 -15
  55. package/dist/extensions/notifications.d.ts +16 -15
  56. package/dist/extensions/notifications.js +5 -6
  57. package/dist/extensions/notifications.mjs +5 -6
  58. package/dist/extensions/payment-requests.d.mts +15 -10
  59. package/dist/extensions/payment-requests.d.ts +15 -10
  60. package/dist/extensions/payment-requests.js +5 -6
  61. package/dist/extensions/payment-requests.mjs +5 -6
  62. package/dist/extensions/products.d.mts +43 -42
  63. package/dist/extensions/products.d.ts +43 -42
  64. package/dist/extensions/products.js +5 -6
  65. package/dist/extensions/products.mjs +5 -6
  66. package/dist/extensions/rain.d.mts +22 -21
  67. package/dist/extensions/rain.d.ts +22 -21
  68. package/dist/extensions/rain.js +5 -6
  69. package/dist/extensions/rain.mjs +5 -6
  70. package/dist/extensions/rewards.d.mts +8 -7
  71. package/dist/extensions/rewards.d.ts +8 -7
  72. package/dist/extensions/rewards.js +5 -6
  73. package/dist/extensions/rewards.mjs +5 -6
  74. package/dist/extensions/stellar-testnet.d.mts +16 -15
  75. package/dist/extensions/stellar-testnet.d.ts +16 -15
  76. package/dist/extensions/stellar-testnet.js +5 -6
  77. package/dist/extensions/stellar-testnet.mjs +5 -6
  78. package/dist/extensions/stellar.d.mts +16 -15
  79. package/dist/extensions/stellar.d.ts +16 -15
  80. package/dist/extensions/stellar.js +5 -6
  81. package/dist/extensions/stellar.mjs +5 -6
  82. package/dist/index.d.mts +2 -2
  83. package/dist/index.d.ts +2 -2
  84. package/dist/index.js +1 -1
  85. package/dist/index.mjs +1 -1
  86. package/dist/react.d.mts +3 -11
  87. package/dist/react.d.ts +3 -11
  88. package/dist/react.js +1 -1
  89. package/dist/react.mjs +1 -1
  90. package/dist/user.d.mts +21 -10
  91. package/dist/user.d.ts +21 -10
  92. package/dist/user.js +1 -1
  93. package/dist/user.mjs +1 -1
  94. package/package.json +1 -1
  95. package/src/auth/create-auth.ts +184 -781
  96. package/src/auth/index.ts +2 -25
  97. package/src/auth/types/index.ts +0 -48
  98. package/src/extensions/alchemy/openapi-ts/client/client.gen.ts +17 -7
  99. package/src/extensions/alchemy/openapi-ts/client/types.gen.ts +2 -1
  100. package/src/extensions/alchemy/openapi-ts/client/utils.gen.ts +1 -1
  101. package/src/extensions/alchemy/openapi-ts/core/bodySerializer.gen.ts +6 -8
  102. package/src/extensions/alchemy/openapi-ts/core/params.gen.ts +1 -1
  103. package/src/extensions/alchemy/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  104. package/src/extensions/alchemy/openapi-ts/core/types.gen.ts +1 -1
  105. package/src/extensions/alchemy/openapi-ts/core/utils.gen.ts +1 -1
  106. package/src/extensions/alchemy/openapi-ts/index.ts +2 -2
  107. package/src/extensions/alchemy/openapi-ts/sdk.gen.ts +44 -2
  108. package/src/extensions/alchemy/openapi-ts/types.gen.ts +177 -34
  109. package/src/extensions/app/openapi-ts/client/client.gen.ts +17 -7
  110. package/src/extensions/app/openapi-ts/client/types.gen.ts +2 -1
  111. package/src/extensions/app/openapi-ts/client/utils.gen.ts +1 -1
  112. package/src/extensions/app/openapi-ts/core/bodySerializer.gen.ts +6 -8
  113. package/src/extensions/app/openapi-ts/core/params.gen.ts +1 -1
  114. package/src/extensions/app/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  115. package/src/extensions/app/openapi-ts/core/types.gen.ts +1 -1
  116. package/src/extensions/app/openapi-ts/core/utils.gen.ts +1 -1
  117. package/src/extensions/app/openapi-ts/sdk.gen.ts +1 -1
  118. package/src/extensions/app/openapi-ts/types.gen.ts +3 -3
  119. package/src/extensions/billing/openapi-ts/client/client.gen.ts +17 -7
  120. package/src/extensions/billing/openapi-ts/client/types.gen.ts +2 -1
  121. package/src/extensions/billing/openapi-ts/client/utils.gen.ts +1 -1
  122. package/src/extensions/billing/openapi-ts/core/bodySerializer.gen.ts +6 -8
  123. package/src/extensions/billing/openapi-ts/core/params.gen.ts +1 -1
  124. package/src/extensions/billing/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  125. package/src/extensions/billing/openapi-ts/core/types.gen.ts +1 -1
  126. package/src/extensions/billing/openapi-ts/core/utils.gen.ts +1 -1
  127. package/src/extensions/billing/openapi-ts/sdk.gen.ts +1 -1
  128. package/src/extensions/billing/openapi-ts/types.gen.ts +3 -3
  129. package/src/extensions/bridge/openapi-ts/client/client.gen.ts +17 -7
  130. package/src/extensions/bridge/openapi-ts/client/types.gen.ts +2 -1
  131. package/src/extensions/bridge/openapi-ts/client/utils.gen.ts +1 -1
  132. package/src/extensions/bridge/openapi-ts/core/bodySerializer.gen.ts +6 -8
  133. package/src/extensions/bridge/openapi-ts/core/params.gen.ts +1 -1
  134. package/src/extensions/bridge/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  135. package/src/extensions/bridge/openapi-ts/core/types.gen.ts +1 -1
  136. package/src/extensions/bridge/openapi-ts/core/utils.gen.ts +1 -1
  137. package/src/extensions/bridge/openapi-ts/index.ts +2 -2
  138. package/src/extensions/bridge/openapi-ts/sdk.gen.ts +90 -2
  139. package/src/extensions/bridge/openapi-ts/types.gen.ts +572 -29
  140. package/src/extensions/builder/openapi-ts/client/client.gen.ts +17 -7
  141. package/src/extensions/builder/openapi-ts/client/types.gen.ts +2 -1
  142. package/src/extensions/builder/openapi-ts/client/utils.gen.ts +1 -1
  143. package/src/extensions/builder/openapi-ts/core/bodySerializer.gen.ts +6 -8
  144. package/src/extensions/builder/openapi-ts/core/params.gen.ts +1 -1
  145. package/src/extensions/builder/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  146. package/src/extensions/builder/openapi-ts/core/types.gen.ts +1 -1
  147. package/src/extensions/builder/openapi-ts/core/utils.gen.ts +1 -1
  148. package/src/extensions/builder/openapi-ts/sdk.gen.ts +1 -1
  149. package/src/extensions/business/openapi-ts/client/client.gen.ts +17 -7
  150. package/src/extensions/business/openapi-ts/client/types.gen.ts +2 -1
  151. package/src/extensions/business/openapi-ts/client/utils.gen.ts +1 -1
  152. package/src/extensions/business/openapi-ts/core/bodySerializer.gen.ts +6 -8
  153. package/src/extensions/business/openapi-ts/core/params.gen.ts +1 -1
  154. package/src/extensions/business/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  155. package/src/extensions/business/openapi-ts/core/types.gen.ts +1 -1
  156. package/src/extensions/business/openapi-ts/core/utils.gen.ts +1 -1
  157. package/src/extensions/business/openapi-ts/sdk.gen.ts +1 -1
  158. package/src/extensions/business/openapi-ts/types.gen.ts +91 -56
  159. package/src/extensions/conversion/openapi-ts/client/client.gen.ts +17 -7
  160. package/src/extensions/conversion/openapi-ts/client/types.gen.ts +2 -1
  161. package/src/extensions/conversion/openapi-ts/client/utils.gen.ts +1 -1
  162. package/src/extensions/conversion/openapi-ts/core/bodySerializer.gen.ts +6 -8
  163. package/src/extensions/conversion/openapi-ts/core/params.gen.ts +1 -1
  164. package/src/extensions/conversion/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  165. package/src/extensions/conversion/openapi-ts/core/types.gen.ts +1 -1
  166. package/src/extensions/conversion/openapi-ts/core/utils.gen.ts +1 -1
  167. package/src/extensions/conversion/openapi-ts/sdk.gen.ts +1 -1
  168. package/src/extensions/conversion/openapi-ts/types.gen.ts +2 -2
  169. package/src/extensions/mass-send/openapi-ts/client/client.gen.ts +17 -7
  170. package/src/extensions/mass-send/openapi-ts/client/types.gen.ts +2 -1
  171. package/src/extensions/mass-send/openapi-ts/client/utils.gen.ts +1 -1
  172. package/src/extensions/mass-send/openapi-ts/core/bodySerializer.gen.ts +6 -8
  173. package/src/extensions/mass-send/openapi-ts/core/params.gen.ts +1 -1
  174. package/src/extensions/mass-send/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  175. package/src/extensions/mass-send/openapi-ts/core/types.gen.ts +1 -1
  176. package/src/extensions/mass-send/openapi-ts/core/utils.gen.ts +1 -1
  177. package/src/extensions/mass-send/openapi-ts/sdk.gen.ts +1 -1
  178. package/src/extensions/notifications/openapi-ts/client/client.gen.ts +17 -7
  179. package/src/extensions/notifications/openapi-ts/client/types.gen.ts +2 -1
  180. package/src/extensions/notifications/openapi-ts/client/utils.gen.ts +1 -1
  181. package/src/extensions/notifications/openapi-ts/core/bodySerializer.gen.ts +6 -8
  182. package/src/extensions/notifications/openapi-ts/core/params.gen.ts +1 -1
  183. package/src/extensions/notifications/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  184. package/src/extensions/notifications/openapi-ts/core/types.gen.ts +1 -1
  185. package/src/extensions/notifications/openapi-ts/core/utils.gen.ts +1 -1
  186. package/src/extensions/notifications/openapi-ts/sdk.gen.ts +1 -1
  187. package/src/extensions/notifications/openapi-ts/types.gen.ts +8 -8
  188. package/src/extensions/payment-requests/openapi-ts/client/client.gen.ts +17 -7
  189. package/src/extensions/payment-requests/openapi-ts/client/types.gen.ts +2 -1
  190. package/src/extensions/payment-requests/openapi-ts/client/utils.gen.ts +1 -1
  191. package/src/extensions/payment-requests/openapi-ts/core/bodySerializer.gen.ts +6 -8
  192. package/src/extensions/payment-requests/openapi-ts/core/params.gen.ts +1 -1
  193. package/src/extensions/payment-requests/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  194. package/src/extensions/payment-requests/openapi-ts/core/types.gen.ts +1 -1
  195. package/src/extensions/payment-requests/openapi-ts/core/utils.gen.ts +1 -1
  196. package/src/extensions/payment-requests/openapi-ts/sdk.gen.ts +1 -1
  197. package/src/extensions/payment-requests/openapi-ts/types.gen.ts +7 -3
  198. package/src/extensions/products/openapi-ts/client/client.gen.ts +17 -7
  199. package/src/extensions/products/openapi-ts/client/types.gen.ts +2 -1
  200. package/src/extensions/products/openapi-ts/client/utils.gen.ts +1 -1
  201. package/src/extensions/products/openapi-ts/core/bodySerializer.gen.ts +6 -8
  202. package/src/extensions/products/openapi-ts/core/params.gen.ts +1 -1
  203. package/src/extensions/products/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  204. package/src/extensions/products/openapi-ts/core/types.gen.ts +1 -1
  205. package/src/extensions/products/openapi-ts/core/utils.gen.ts +1 -1
  206. package/src/extensions/products/openapi-ts/sdk.gen.ts +1 -1
  207. package/src/extensions/products/openapi-ts/types.gen.ts +35 -35
  208. package/src/extensions/rain/openapi-ts/client/client.gen.ts +17 -7
  209. package/src/extensions/rain/openapi-ts/client/types.gen.ts +2 -1
  210. package/src/extensions/rain/openapi-ts/client/utils.gen.ts +1 -1
  211. package/src/extensions/rain/openapi-ts/core/bodySerializer.gen.ts +6 -8
  212. package/src/extensions/rain/openapi-ts/core/params.gen.ts +1 -1
  213. package/src/extensions/rain/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  214. package/src/extensions/rain/openapi-ts/core/types.gen.ts +1 -1
  215. package/src/extensions/rain/openapi-ts/core/utils.gen.ts +1 -1
  216. package/src/extensions/rain/openapi-ts/sdk.gen.ts +1 -1
  217. package/src/extensions/rain/openapi-ts/types.gen.ts +14 -14
  218. package/src/extensions/rewards/openapi-ts/client/client.gen.ts +17 -7
  219. package/src/extensions/rewards/openapi-ts/client/types.gen.ts +2 -1
  220. package/src/extensions/rewards/openapi-ts/client/utils.gen.ts +1 -1
  221. package/src/extensions/rewards/openapi-ts/core/bodySerializer.gen.ts +6 -8
  222. package/src/extensions/rewards/openapi-ts/core/params.gen.ts +1 -1
  223. package/src/extensions/rewards/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  224. package/src/extensions/rewards/openapi-ts/core/types.gen.ts +1 -1
  225. package/src/extensions/rewards/openapi-ts/core/utils.gen.ts +1 -1
  226. package/src/extensions/rewards/openapi-ts/sdk.gen.ts +1 -1
  227. package/src/extensions/stellar/openapi-ts/client/client.gen.ts +17 -7
  228. package/src/extensions/stellar/openapi-ts/client/types.gen.ts +2 -1
  229. package/src/extensions/stellar/openapi-ts/client/utils.gen.ts +1 -1
  230. package/src/extensions/stellar/openapi-ts/core/bodySerializer.gen.ts +6 -8
  231. package/src/extensions/stellar/openapi-ts/core/params.gen.ts +1 -1
  232. package/src/extensions/stellar/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  233. package/src/extensions/stellar/openapi-ts/core/types.gen.ts +1 -1
  234. package/src/extensions/stellar/openapi-ts/core/utils.gen.ts +1 -1
  235. package/src/extensions/stellar/openapi-ts/sdk.gen.ts +1 -1
  236. package/src/extensions/stellar/openapi-ts/types.gen.ts +8 -8
  237. package/src/extensions/stellar-testnet/openapi-ts/client/client.gen.ts +17 -7
  238. package/src/extensions/stellar-testnet/openapi-ts/client/types.gen.ts +2 -1
  239. package/src/extensions/stellar-testnet/openapi-ts/client/utils.gen.ts +1 -1
  240. package/src/extensions/stellar-testnet/openapi-ts/core/bodySerializer.gen.ts +6 -8
  241. package/src/extensions/stellar-testnet/openapi-ts/core/params.gen.ts +1 -1
  242. package/src/extensions/stellar-testnet/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  243. package/src/extensions/stellar-testnet/openapi-ts/core/types.gen.ts +1 -1
  244. package/src/extensions/stellar-testnet/openapi-ts/core/utils.gen.ts +1 -1
  245. package/src/extensions/stellar-testnet/openapi-ts/sdk.gen.ts +1 -1
  246. package/src/extensions/stellar-testnet/openapi-ts/types.gen.ts +8 -8
  247. package/src/platform/admin/openapi-ts/client/client.gen.ts +17 -7
  248. package/src/platform/admin/openapi-ts/client/types.gen.ts +2 -1
  249. package/src/platform/admin/openapi-ts/client/utils.gen.ts +1 -1
  250. package/src/platform/admin/openapi-ts/core/bodySerializer.gen.ts +6 -8
  251. package/src/platform/admin/openapi-ts/core/params.gen.ts +1 -1
  252. package/src/platform/admin/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  253. package/src/platform/admin/openapi-ts/core/types.gen.ts +1 -1
  254. package/src/platform/admin/openapi-ts/core/utils.gen.ts +1 -1
  255. package/src/platform/admin/openapi-ts/index.ts +2 -2
  256. package/src/platform/admin/openapi-ts/sdk.gen.ts +54 -12
  257. package/src/platform/admin/openapi-ts/types.gen.ts +623 -107
  258. package/src/platform/user/openapi-ts/client/client.gen.ts +17 -7
  259. package/src/platform/user/openapi-ts/client/types.gen.ts +2 -1
  260. package/src/platform/user/openapi-ts/client/utils.gen.ts +1 -1
  261. package/src/platform/user/openapi-ts/core/bodySerializer.gen.ts +6 -8
  262. package/src/platform/user/openapi-ts/core/params.gen.ts +1 -1
  263. package/src/platform/user/openapi-ts/core/serverSentEvents.gen.ts +4 -5
  264. package/src/platform/user/openapi-ts/core/types.gen.ts +1 -1
  265. package/src/platform/user/openapi-ts/core/utils.gen.ts +1 -1
  266. package/src/platform/user/openapi-ts/index.ts +2 -2
  267. package/src/platform/user/openapi-ts/sdk.gen.ts +30 -4
  268. package/src/platform/user/openapi-ts/types.gen.ts +116 -52
  269. package/dist/chunk-7USVOK77.js +0 -7
  270. package/dist/chunk-G3M5QMRX.js +0 -1
  271. package/dist/chunk-HSPTEN45.mjs +0 -1
  272. package/dist/chunk-HWXE5WBF.js +0 -7
  273. package/dist/chunk-MUN3POSM.mjs +0 -7
  274. package/dist/chunk-ZUZHOLAX.mjs +0 -7
@@ -168,6 +168,7 @@ export type AdminAccount = {
168
168
  label?: string | null;
169
169
  primary?: boolean;
170
170
  recon?: boolean;
171
+ hidden?: boolean;
171
172
  user: ReducedUserInfo;
172
173
  readonly currencies: Array<AdminReducedAccountAccountAsset>;
173
174
  metadata?: {
@@ -415,6 +416,44 @@ export type AdminAccountResponse = {
415
416
  data: AdminAccount;
416
417
  };
417
418
 
419
+ /**
420
+ * A ModelSerializer that takes additional arguments for
421
+ * "fields", "omit" and "expand" in order to
422
+ * control which fields are displayed, and whether to replace simple
423
+ * values with complex, nested serializations
424
+ */
425
+ export type AdminAlert = {
426
+ readonly id: string;
427
+ readonly transaction: string | null;
428
+ user: ReducedUserInfo;
429
+ author: ReducedUserInfo;
430
+ name: string;
431
+ description?: string | null;
432
+ /**
433
+ * * `info` - Info
434
+ * * `low` - Low
435
+ * * `medium` - Medium
436
+ * * `high` - High
437
+ * * `critical` - Critical
438
+ */
439
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
440
+ /**
441
+ * * `open` - Open
442
+ * * `assigned` - Assigned
443
+ * * `paused` - Paused
444
+ * * `closed` - Closed
445
+ * * `reopened` - Reopened
446
+ */
447
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
448
+ metadata?: {
449
+ [key: string]: unknown;
450
+ } | null;
451
+ readonly external: boolean;
452
+ archived?: boolean;
453
+ readonly created: string;
454
+ readonly updated: string;
455
+ };
456
+
418
457
  /**
419
458
  * A ModelSerializer that takes additional arguments for
420
459
  * "fields", "omit" and "expand" in order to
@@ -469,6 +508,7 @@ export type AdminAssetResponse = {
469
508
  export type AdminAuthToken = {
470
509
  readonly token_key: string;
471
510
  user: ReducedUserInfo;
511
+ readonly label: string;
472
512
  readonly expires: number;
473
513
  readonly created: number;
474
514
  };
@@ -491,7 +531,7 @@ export type AdminAuthenticatorRule = {
491
531
  * * `authorization` - Authorization
492
532
  * * `setup` - Setup
493
533
  */
494
- type: 'authentication' | 'authorization' | 'setup';
534
+ readonly type: 'authentication' | 'authorization' | 'setup';
495
535
  /**
496
536
  * * `ephemeral` - Ephemeral
497
537
  * * `durable` - Durable
@@ -793,7 +833,7 @@ export type AdminCompany = {
793
833
  * * `test` - Test
794
834
  * * `production` - Production
795
835
  */
796
- mode: 'test' | 'production';
836
+ readonly mode: 'test' | 'production';
797
837
  /**
798
838
  * * `pending` - Pending
799
839
  * * `active` - Active
@@ -853,6 +893,7 @@ export type AdminCompanyBankAccount = {
853
893
  name?: string | null;
854
894
  number?: string | null;
855
895
  type?: string | null;
896
+ payment_method?: string | null;
856
897
  bank_name?: string | null;
857
898
  bank_code?: string | null;
858
899
  bank_currency?: string | null;
@@ -866,6 +907,7 @@ export type AdminCompanyBankAccount = {
866
907
  check_digit?: string | null;
867
908
  pix_key?: string | null;
868
909
  br_code?: string | null;
910
+ sort_code?: string | null;
869
911
  metadata?: {
870
912
  [key: string]: unknown;
871
913
  } | null;
@@ -912,6 +954,7 @@ export type AdminCompanyBankAccountRequest = {
912
954
  name?: string | null;
913
955
  number?: string | null;
914
956
  type?: string | null;
957
+ payment_method?: string | null;
915
958
  bank_name?: string | null;
916
959
  bank_code?: string | null;
917
960
  bank_currency?: string | null;
@@ -925,6 +968,7 @@ export type AdminCompanyBankAccountRequest = {
925
968
  check_digit?: string | null;
926
969
  pix_key?: string | null;
927
970
  br_code?: string | null;
971
+ sort_code?: string | null;
928
972
  metadata?: {
929
973
  [key: string]: unknown;
930
974
  } | null;
@@ -954,7 +998,7 @@ export type AdminCompanyLink = {
954
998
  * * `pending` - Pending
955
999
  * * `complete` - Complete
956
1000
  */
957
- status: 'pending' | 'complete';
1001
+ readonly status: 'pending' | 'complete';
958
1002
  readonly created: number;
959
1003
  readonly updated: number;
960
1004
  };
@@ -971,7 +1015,7 @@ export type AdminCompanyLinkCounterparty = {
971
1015
  * * `pending` - Pending
972
1016
  * * `complete` - Complete
973
1017
  */
974
- status: 'pending' | 'complete';
1018
+ readonly status: 'pending' | 'complete';
975
1019
  };
976
1020
 
977
1021
  export type AdminCompanyLinkResponse = {
@@ -1480,10 +1524,45 @@ export type AdminCreateAccountRequest = {
1480
1524
  label?: string | null;
1481
1525
  primary?: boolean;
1482
1526
  recon?: boolean;
1527
+ hidden?: boolean;
1528
+ metadata?: {
1529
+ [key: string]: unknown;
1530
+ } | null;
1531
+ archived?: boolean;
1532
+ };
1533
+
1534
+ /**
1535
+ * A ModelSerializer that takes additional arguments for
1536
+ * "fields", "omit" and "expand" in order to
1537
+ * control which fields are displayed, and whether to replace simple
1538
+ * values with complex, nested serializations
1539
+ */
1540
+ export type AdminCreateAlertRequest = {
1541
+ name: string;
1542
+ description?: string | null;
1543
+ /**
1544
+ * * `info` - Info
1545
+ * * `low` - Low
1546
+ * * `medium` - Medium
1547
+ * * `high` - High
1548
+ * * `critical` - Critical
1549
+ */
1550
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
1551
+ /**
1552
+ * * `open` - Open
1553
+ * * `assigned` - Assigned
1554
+ * * `paused` - Paused
1555
+ * * `closed` - Closed
1556
+ * * `reopened` - Reopened
1557
+ */
1558
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
1483
1559
  metadata?: {
1484
1560
  [key: string]: unknown;
1485
1561
  } | null;
1486
1562
  archived?: boolean;
1563
+ actions?: Array<{
1564
+ [key: string]: unknown;
1565
+ }>;
1487
1566
  };
1488
1567
 
1489
1568
  /**
@@ -1515,6 +1594,7 @@ export type AdminCreateAssetRequest = {
1515
1594
  export type AdminCreateAuthTokenRequest = {
1516
1595
  duration?: number | null;
1517
1596
  user: string;
1597
+ label?: string | null;
1518
1598
  };
1519
1599
 
1520
1600
  /**
@@ -1634,10 +1714,11 @@ export type AdminCreateCryptoAccountRequest = {
1634
1714
  * * `obsolete` - Obsolete
1635
1715
  * * `declined` - Declined
1636
1716
  * * `pending` - Pending
1717
+ * * `paused` - Paused
1637
1718
  * * `incomplete` - Incomplete
1638
1719
  * * `verified` - Verified
1639
1720
  */
1640
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
1721
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
1641
1722
  archived?: boolean;
1642
1723
  /**
1643
1724
  * * `withdraw` - Withdraw
@@ -2297,10 +2378,11 @@ export type AdminCreateUserAddressRequest = {
2297
2378
  * * `obsolete` - Obsolete
2298
2379
  * * `declined` - Declined
2299
2380
  * * `pending` - Pending
2381
+ * * `paused` - Paused
2300
2382
  * * `incomplete` - Incomplete
2301
2383
  * * `verified` - Verified
2302
2384
  */
2303
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
2385
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
2304
2386
  archived?: boolean;
2305
2387
  };
2306
2388
 
@@ -2335,6 +2417,7 @@ export type AdminCreateUserBankAccountRequest = {
2335
2417
  owner?: BankOwnerRequest | null;
2336
2418
  number?: string | null;
2337
2419
  type?: string | null;
2420
+ payment_method?: string | null;
2338
2421
  /**
2339
2422
  * * `individual` - Individual
2340
2423
  * * `business` - Business
@@ -2354,14 +2437,16 @@ export type AdminCreateUserBankAccountRequest = {
2354
2437
  check_digit?: string | null;
2355
2438
  pix_key?: string | null;
2356
2439
  br_code?: string | null;
2440
+ sort_code?: string | null;
2357
2441
  /**
2358
2442
  * * `obsolete` - Obsolete
2359
2443
  * * `declined` - Declined
2360
2444
  * * `pending` - Pending
2445
+ * * `paused` - Paused
2361
2446
  * * `incomplete` - Incomplete
2362
2447
  * * `verified` - Verified
2363
2448
  */
2364
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
2449
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
2365
2450
  metadata?: {
2366
2451
  [key: string]: unknown;
2367
2452
  } | null;
@@ -2384,10 +2469,11 @@ export type AdminCreateUserDocumentRequest = {
2384
2469
  * * `obsolete` - Obsolete
2385
2470
  * * `declined` - Declined
2386
2471
  * * `pending` - Pending
2472
+ * * `paused` - Paused
2387
2473
  * * `incomplete` - Incomplete
2388
2474
  * * `verified` - Verified
2389
2475
  */
2390
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
2476
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
2391
2477
  metadata?: {
2392
2478
  [key: string]: unknown;
2393
2479
  } | null;
@@ -3041,10 +3127,11 @@ export type AdminCreateUserWalletAccountRequest = {
3041
3127
  * * `obsolete` - Obsolete
3042
3128
  * * `declined` - Declined
3043
3129
  * * `pending` - Pending
3130
+ * * `paused` - Paused
3044
3131
  * * `incomplete` - Incomplete
3045
3132
  * * `verified` - Verified
3046
3133
  */
3047
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
3134
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
3048
3135
  archived?: boolean;
3049
3136
  /**
3050
3137
  * * `withdraw` - Withdraw
@@ -3084,10 +3171,11 @@ export type AdminCryptoAccount = {
3084
3171
  * * `obsolete` - Obsolete
3085
3172
  * * `declined` - Declined
3086
3173
  * * `pending` - Pending
3174
+ * * `paused` - Paused
3087
3175
  * * `incomplete` - Incomplete
3088
3176
  * * `verified` - Verified
3089
3177
  */
3090
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
3178
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
3091
3179
  readonly currencies: Array<ReducedAsset>;
3092
3180
  readonly account_currencies: Array<ReducedAccountAsset>;
3093
3181
  archived?: boolean;
@@ -3159,10 +3247,11 @@ export type AdminCryptoAccountRequest = {
3159
3247
  * * `obsolete` - Obsolete
3160
3248
  * * `declined` - Declined
3161
3249
  * * `pending` - Pending
3250
+ * * `paused` - Paused
3162
3251
  * * `incomplete` - Incomplete
3163
3252
  * * `verified` - Verified
3164
3253
  */
3165
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
3254
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
3166
3255
  archived?: boolean;
3167
3256
  /**
3168
3257
  * * `withdraw` - Withdraw
@@ -3367,7 +3456,7 @@ export type AdminExport = {
3367
3456
  * * `transaction` - Transaction
3368
3457
  * * `user` - User
3369
3458
  */
3370
- resource: 'account' | 'account_currency' | 'transaction' | 'user';
3459
+ readonly resource: 'account' | 'account_currency' | 'transaction' | 'user';
3371
3460
  query?: {
3372
3461
  [key: string]: unknown;
3373
3462
  } | null;
@@ -3377,7 +3466,7 @@ export type AdminExport = {
3377
3466
  * * `complete` - Complete
3378
3467
  * * `failed` - Failed
3379
3468
  */
3380
- status: 'queued' | 'processing' | 'complete' | 'failed';
3469
+ readonly status: 'queued' | 'processing' | 'complete' | 'failed';
3381
3470
  progress: number;
3382
3471
  count?: number | null;
3383
3472
  page_size?: number;
@@ -3385,7 +3474,7 @@ export type AdminExport = {
3385
3474
  * * `json` - JSON
3386
3475
  * * `csv` - CSV
3387
3476
  */
3388
- file_format: 'json' | 'csv';
3477
+ readonly file_format: 'json' | 'csv';
3389
3478
  readonly created: number;
3390
3479
  readonly updated: number;
3391
3480
  user: ReducedUserInfo;
@@ -3426,6 +3515,7 @@ export type AdminExtendedAccount = {
3426
3515
  label?: string | null;
3427
3516
  primary?: boolean;
3428
3517
  recon?: boolean;
3518
+ hidden?: boolean;
3429
3519
  user: ReducedUserInfo;
3430
3520
  readonly currencies: Array<AdminAccountAccountAsset>;
3431
3521
  metadata?: {
@@ -3441,10 +3531,91 @@ export type AdminExtendedAccountResponse = {
3441
3531
  data: AdminExtendedAccount;
3442
3532
  };
3443
3533
 
3534
+ /**
3535
+ * A ModelSerializer that takes additional arguments for
3536
+ * "fields", "omit" and "expand" in order to
3537
+ * control which fields are displayed, and whether to replace simple
3538
+ * values with complex, nested serializations
3539
+ */
3540
+ export type AdminExtendedAlert = {
3541
+ readonly id: string;
3542
+ readonly transaction: string | null;
3543
+ user: ReducedUserInfo;
3544
+ author: ReducedUserInfo;
3545
+ name: string;
3546
+ description?: string | null;
3547
+ /**
3548
+ * * `info` - Info
3549
+ * * `low` - Low
3550
+ * * `medium` - Medium
3551
+ * * `high` - High
3552
+ * * `critical` - Critical
3553
+ */
3554
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
3555
+ /**
3556
+ * * `open` - Open
3557
+ * * `assigned` - Assigned
3558
+ * * `paused` - Paused
3559
+ * * `closed` - Closed
3560
+ * * `reopened` - Reopened
3561
+ */
3562
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
3563
+ metadata?: {
3564
+ [key: string]: unknown;
3565
+ } | null;
3566
+ readonly external: boolean;
3567
+ archived?: boolean;
3568
+ readonly created: string;
3569
+ readonly updated: string;
3570
+ actions?: Array<{
3571
+ [key: string]: unknown;
3572
+ }>;
3573
+ };
3574
+
3575
+ /**
3576
+ * A ModelSerializer that takes additional arguments for
3577
+ * "fields", "omit" and "expand" in order to
3578
+ * control which fields are displayed, and whether to replace simple
3579
+ * values with complex, nested serializations
3580
+ */
3581
+ export type AdminExtendedAlertRequest = {
3582
+ name: string;
3583
+ description?: string | null;
3584
+ /**
3585
+ * * `info` - Info
3586
+ * * `low` - Low
3587
+ * * `medium` - Medium
3588
+ * * `high` - High
3589
+ * * `critical` - Critical
3590
+ */
3591
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
3592
+ /**
3593
+ * * `open` - Open
3594
+ * * `assigned` - Assigned
3595
+ * * `paused` - Paused
3596
+ * * `closed` - Closed
3597
+ * * `reopened` - Reopened
3598
+ */
3599
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
3600
+ metadata?: {
3601
+ [key: string]: unknown;
3602
+ } | null;
3603
+ archived?: boolean;
3604
+ actions?: Array<{
3605
+ [key: string]: unknown;
3606
+ }>;
3607
+ };
3608
+
3609
+ export type AdminExtendedAlertResponse = {
3610
+ status: string;
3611
+ data: AdminExtendedAlert;
3612
+ };
3613
+
3444
3614
  export type AdminExtendedAuthToken = {
3445
3615
  readonly token_key: string;
3446
3616
  readonly token: string;
3447
3617
  user: ReducedUserInfo;
3618
+ readonly label: string;
3448
3619
  readonly expires: number;
3449
3620
  readonly created: number;
3450
3621
  };
@@ -3474,7 +3645,7 @@ export type AdminExtendedExport = {
3474
3645
  * * `transaction` - Transaction
3475
3646
  * * `user` - User
3476
3647
  */
3477
- resource: 'account' | 'account_currency' | 'transaction' | 'user';
3648
+ readonly resource: 'account' | 'account_currency' | 'transaction' | 'user';
3478
3649
  readonly query: {
3479
3650
  [key: string]: unknown;
3480
3651
  } | null;
@@ -3484,7 +3655,7 @@ export type AdminExtendedExport = {
3484
3655
  * * `complete` - Complete
3485
3656
  * * `failed` - Failed
3486
3657
  */
3487
- status: 'queued' | 'processing' | 'complete' | 'failed';
3658
+ readonly status: 'queued' | 'processing' | 'complete' | 'failed';
3488
3659
  progress: number;
3489
3660
  readonly count: number | null;
3490
3661
  readonly page_size: number;
@@ -3493,7 +3664,7 @@ export type AdminExtendedExport = {
3493
3664
  * * `json` - JSON
3494
3665
  * * `csv` - CSV
3495
3666
  */
3496
- file_format: 'json' | 'csv';
3667
+ readonly file_format: 'json' | 'csv';
3497
3668
  readonly created: number;
3498
3669
  readonly updated: number;
3499
3670
  user: ReducedUserInfo;
@@ -3558,6 +3729,7 @@ export type AdminExtendedRequest = {
3558
3729
  readonly id: number;
3559
3730
  user: ReducedUserInfo;
3560
3731
  readonly key: string | null;
3732
+ readonly token_key: string | null;
3561
3733
  readonly scheme: string;
3562
3734
  readonly path: string | null;
3563
3735
  readonly method: string;
@@ -3581,6 +3753,7 @@ export type AdminExtendedRequest = {
3581
3753
  * * `accountdefinition` - Account Definition
3582
3754
  * * `accountdefinitiongroup` - Account Definition Group
3583
3755
  * * `accountdefinitiongroupcurrency` - Account Definition Group Currency
3756
+ * * `alert` - Alert
3584
3757
  * * `currency` - Currency
3585
3758
  * * `authenticator` - Authenticator
3586
3759
  * * `authenticatorchallenge` - Authenticator Challenge
@@ -3653,7 +3826,7 @@ export type AdminExtendedRequest = {
3653
3826
  * * `webhooktask` - Webhook Task
3654
3827
  * * `webhookrequest` - Webhook Request
3655
3828
  */
3656
- resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
3829
+ resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'alert' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
3657
3830
  readonly resource_id: string | null;
3658
3831
  /**
3659
3832
  * Return a response object. This has to be unpickled from a stored
@@ -3692,7 +3865,7 @@ export type AdminExtendedTransaction = {
3692
3865
  * * `credit` - Credit
3693
3866
  * * `debit` - Debit
3694
3867
  */
3695
- tx_type: 'credit' | 'debit';
3868
+ readonly tx_type: 'credit' | 'debit';
3696
3869
  readonly subtype: string | null;
3697
3870
  note?: string;
3698
3871
  metadata?: {
@@ -3705,7 +3878,7 @@ export type AdminExtendedTransaction = {
3705
3878
  * * `Complete` - Complete
3706
3879
  * * `Failed` - Failed
3707
3880
  */
3708
- status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3881
+ readonly status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3709
3882
  readonly reference: string | null;
3710
3883
  readonly amount: number;
3711
3884
  readonly fee: number;
@@ -3768,7 +3941,7 @@ export type AdminExtendedTransactionTransition = {
3768
3941
  * * `approved` - Approved
3769
3942
  * * `declined` - Declined
3770
3943
  */
3771
- status: 'queued' | 'pending' | 'approved' | 'declined';
3944
+ readonly status: 'queued' | 'pending' | 'approved' | 'declined';
3772
3945
  /**
3773
3946
  * * `Initiating` - Initiating
3774
3947
  * * `Quoted` - Quoted
@@ -3776,7 +3949,7 @@ export type AdminExtendedTransactionTransition = {
3776
3949
  * * `Complete` - Complete
3777
3950
  * * `Failed` - Failed
3778
3951
  */
3779
- from_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3952
+ readonly from_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3780
3953
  /**
3781
3954
  * * `Initiating` - Initiating
3782
3955
  * * `Quoted` - Quoted
@@ -3784,7 +3957,7 @@ export type AdminExtendedTransactionTransition = {
3784
3957
  * * `Complete` - Complete
3785
3958
  * * `Failed` - Failed
3786
3959
  */
3787
- to_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3960
+ readonly to_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
3788
3961
  readonly index: number;
3789
3962
  readonly archived: boolean;
3790
3963
  readonly created: number;
@@ -4366,10 +4539,11 @@ export type AdminExtendedUserInfo = {
4366
4539
  * * `obsolete` - Obsolete
4367
4540
  * * `declined` - Declined
4368
4541
  * * `pending` - Pending
4542
+ * * `paused` - Paused
4369
4543
  * * `incomplete` - Incomplete
4370
4544
  * * `verified` - Verified
4371
4545
  */
4372
- status: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
4546
+ readonly status: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
4373
4547
  readonly created: number;
4374
4548
  readonly updated: number;
4375
4549
  deactivated?: boolean;
@@ -4550,12 +4724,13 @@ export type AdminGroupPermission = {
4550
4724
  * * `admin` - Admin
4551
4725
  * * `user` - User
4552
4726
  */
4553
- section: 'system' | 'admin' | 'user';
4727
+ readonly section: 'system' | 'admin' | 'user';
4554
4728
  /**
4555
4729
  * * `accesscontrolrule` - Access Control Rule
4556
4730
  * * `account` - Account
4557
4731
  * * `accountdefinition` - Account Definition
4558
4732
  * * `address` - Address
4733
+ * * `alert` - Alert
4559
4734
  * * `currency` - Currency
4560
4735
  * * `bankaccount` - Bank Account
4561
4736
  * * `company` - Company
@@ -4580,14 +4755,14 @@ export type AdminGroupPermission = {
4580
4755
  * * `user` - User
4581
4756
  * * `webhook` - Webhook
4582
4757
  */
4583
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
4758
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
4584
4759
  /**
4585
4760
  * * `view` - View
4586
4761
  * * `add` - Add
4587
4762
  * * `change` - Change
4588
4763
  * * `delete` - Delete
4589
4764
  */
4590
- level: 'view' | 'add' | 'change' | 'delete';
4765
+ readonly level: 'view' | 'add' | 'change' | 'delete';
4591
4766
  properties?: {
4592
4767
  [key: string]: unknown;
4593
4768
  } | null;
@@ -4810,7 +4985,7 @@ export type AdminLegalTerm = {
4810
4985
  * * `system` - System
4811
4986
  * * `company` - Company
4812
4987
  */
4813
- type: 'system' | 'company';
4988
+ readonly type: 'system' | 'company';
4814
4989
  name: string;
4815
4990
  description?: string | null;
4816
4991
  readonly groups: Array<string>;
@@ -4881,7 +5056,7 @@ export type AdminMfaAuthenticator = {
4881
5056
  * * `sms` - Sms
4882
5057
  * * `static` - Static
4883
5058
  */
4884
- type: 'totp' | 'sms' | 'static';
5059
+ readonly type: 'totp' | 'sms' | 'static';
4885
5060
  user: ReducedUserInfo;
4886
5061
  readonly verified: boolean;
4887
5062
  };
@@ -4919,7 +5094,7 @@ export type AdminMetric = {
4919
5094
  * * `user_active_count` - User Active Count
4920
5095
  * * `user_transacted_in_30days_count` - User Transacted In 30Days Count
4921
5096
  */
4922
- type: 'account_count' | 'transaction_count' | 'transaction_complete_count' | 'transaction_failed_count' | 'transaction_pending_count' | 'transaction_complete_sum' | 'transaction_failed_sum' | 'transaction_pending_sum' | 'transaction_balance_sum' | 'transaction_available_balance_sum' | 'user_count' | 'user_active_count' | 'user_transacted_in_30days_count';
5097
+ readonly type: 'account_count' | 'transaction_count' | 'transaction_complete_count' | 'transaction_failed_count' | 'transaction_pending_count' | 'transaction_complete_sum' | 'transaction_failed_sum' | 'transaction_pending_sum' | 'transaction_balance_sum' | 'transaction_available_balance_sum' | 'user_count' | 'user_active_count' | 'user_transacted_in_30days_count';
4923
5098
  currency: ReducedAsset;
4924
5099
  readonly timezone: string;
4925
5100
  readonly query: {
@@ -4929,7 +5104,7 @@ export type AdminMetric = {
4929
5104
  * * `accumulate` - Accumulate
4930
5105
  * * `set` - Set
4931
5106
  */
4932
- method: 'accumulate' | 'set';
5107
+ readonly method: 'accumulate' | 'set';
4933
5108
  readonly created: number;
4934
5109
  readonly updated: number;
4935
5110
  user: ReducedUserInfo;
@@ -5794,6 +5969,7 @@ export type AdminRequest = {
5794
5969
  readonly id: number;
5795
5970
  user: ReducedUserInfo;
5796
5971
  readonly key: string | null;
5972
+ readonly token_key: string | null;
5797
5973
  readonly scheme: string;
5798
5974
  readonly path: string | null;
5799
5975
  readonly method: string;
@@ -5817,6 +5993,7 @@ export type AdminRequest = {
5817
5993
  * * `accountdefinition` - Account Definition
5818
5994
  * * `accountdefinitiongroup` - Account Definition Group
5819
5995
  * * `accountdefinitiongroupcurrency` - Account Definition Group Currency
5996
+ * * `alert` - Alert
5820
5997
  * * `currency` - Currency
5821
5998
  * * `authenticator` - Authenticator
5822
5999
  * * `authenticatorchallenge` - Authenticator Challenge
@@ -5889,7 +6066,7 @@ export type AdminRequest = {
5889
6066
  * * `webhooktask` - Webhook Task
5890
6067
  * * `webhookrequest` - Webhook Request
5891
6068
  */
5892
- resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
6069
+ resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'alert' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
5893
6070
  readonly resource_id: string | null;
5894
6071
  readonly created: number;
5895
6072
  readonly updated: number;
@@ -5914,7 +6091,7 @@ export type AdminService = {
5914
6091
  * * `public` - Public
5915
6092
  * * `private` - Private
5916
6093
  */
5917
- type: 'system' | 'public' | 'private';
6094
+ readonly type: 'system' | 'public' | 'private';
5918
6095
  name: string;
5919
6096
  description?: string | null;
5920
6097
  tags?: Array<string> | null;
@@ -5965,7 +6142,7 @@ export type AdminStatement = {
5965
6142
  * * `complete` - Complete
5966
6143
  * * `failed` - Failed
5967
6144
  */
5968
- status: 'queued' | 'processing' | 'complete' | 'failed';
6145
+ readonly status: 'queued' | 'processing' | 'complete' | 'failed';
5969
6146
  readonly created: number;
5970
6147
  readonly updated: number;
5971
6148
  archived?: boolean;
@@ -5996,7 +6173,7 @@ export type AdminTransaction = {
5996
6173
  * * `credit` - Credit
5997
6174
  * * `debit` - Debit
5998
6175
  */
5999
- tx_type: 'credit' | 'debit';
6176
+ readonly tx_type: 'credit' | 'debit';
6000
6177
  readonly subtype: string | null;
6001
6178
  readonly note: string;
6002
6179
  readonly metadata: {
@@ -6009,7 +6186,7 @@ export type AdminTransaction = {
6009
6186
  * * `Complete` - Complete
6010
6187
  * * `Failed` - Failed
6011
6188
  */
6012
- status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6189
+ readonly status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6013
6190
  readonly reference: string | null;
6014
6191
  readonly amount: number;
6015
6192
  readonly fee: number;
@@ -6044,7 +6221,7 @@ export type AdminTransactionCollection = {
6044
6221
  * * `Complete` - Complete
6045
6222
  * * `Failed` - Failed
6046
6223
  */
6047
- status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6224
+ readonly status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6048
6225
  archived?: boolean;
6049
6226
  readonly created: number;
6050
6227
  readonly updated: number;
@@ -6075,7 +6252,7 @@ export type AdminTransactionCollectionTransaction = {
6075
6252
  * * `credit` - Credit
6076
6253
  * * `debit` - Debit
6077
6254
  */
6078
- tx_type: 'credit' | 'debit';
6255
+ readonly tx_type: 'credit' | 'debit';
6079
6256
  readonly subtype: string | null;
6080
6257
  readonly note: string;
6081
6258
  readonly metadata: {
@@ -6088,7 +6265,7 @@ export type AdminTransactionCollectionTransaction = {
6088
6265
  * * `Complete` - Complete
6089
6266
  * * `Failed` - Failed
6090
6267
  */
6091
- status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6268
+ readonly status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6092
6269
  readonly reference: string | null;
6093
6270
  readonly amount: number;
6094
6271
  readonly fee: number;
@@ -6173,14 +6350,14 @@ export type AdminTransactionSubtype = {
6173
6350
  * * `credit` - Credit
6174
6351
  * * `debit` - Debit
6175
6352
  */
6176
- tx_type: 'credit' | 'debit';
6353
+ readonly tx_type: 'credit' | 'debit';
6177
6354
  /**
6178
6355
  * * `partner` - Partner
6179
6356
  * * `single` - Single
6180
6357
  *
6181
6358
  * @deprecated
6182
6359
  */
6183
- usage_type: 'partner' | 'single' | null;
6360
+ readonly usage_type: 'partner' | 'single' | null;
6184
6361
  partner: ReducedTransactionSubtype;
6185
6362
  archived?: boolean;
6186
6363
  readonly created: number;
@@ -6215,7 +6392,7 @@ export type AdminTransactionTransition = {
6215
6392
  * * `approved` - Approved
6216
6393
  * * `declined` - Declined
6217
6394
  */
6218
- status: 'queued' | 'pending' | 'approved' | 'declined';
6395
+ readonly status: 'queued' | 'pending' | 'approved' | 'declined';
6219
6396
  /**
6220
6397
  * * `Initiating` - Initiating
6221
6398
  * * `Quoted` - Quoted
@@ -6223,7 +6400,7 @@ export type AdminTransactionTransition = {
6223
6400
  * * `Complete` - Complete
6224
6401
  * * `Failed` - Failed
6225
6402
  */
6226
- from_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6403
+ readonly from_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6227
6404
  /**
6228
6405
  * * `Initiating` - Initiating
6229
6406
  * * `Quoted` - Quoted
@@ -6231,7 +6408,7 @@ export type AdminTransactionTransition = {
6231
6408
  * * `Complete` - Complete
6232
6409
  * * `Failed` - Failed
6233
6410
  */
6234
- to_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6411
+ readonly to_status: 'Initiating' | 'Quoted' | 'Pending' | 'Complete' | 'Failed';
6235
6412
  readonly index: number;
6236
6413
  readonly archived: boolean;
6237
6414
  readonly created: number;
@@ -6286,7 +6463,8 @@ export type AdminUpdateAssetRequest = {
6286
6463
  * values with complex, nested serializations
6287
6464
  */
6288
6465
  export type AdminUpdateAuthTokenRequest = {
6289
- expires: number;
6466
+ label?: string | null;
6467
+ expires?: number;
6290
6468
  };
6291
6469
 
6292
6470
  /**
@@ -6364,6 +6542,7 @@ export type AdminUpdateExtendedAccountRequest = {
6364
6542
  label?: string | null;
6365
6543
  primary?: boolean;
6366
6544
  recon?: boolean;
6545
+ hidden?: boolean;
6367
6546
  metadata?: {
6368
6547
  [key: string]: unknown;
6369
6548
  } | null;
@@ -6562,12 +6741,13 @@ export type AdminUpdateServicePermission = {
6562
6741
  * * `admin` - Admin
6563
6742
  * * `user` - User
6564
6743
  */
6565
- section: 'system' | 'admin' | 'user';
6744
+ readonly section: 'system' | 'admin' | 'user';
6566
6745
  /**
6567
6746
  * * `accesscontrolrule` - Access Control Rule
6568
6747
  * * `account` - Account
6569
6748
  * * `accountdefinition` - Account Definition
6570
6749
  * * `address` - Address
6750
+ * * `alert` - Alert
6571
6751
  * * `currency` - Currency
6572
6752
  * * `bankaccount` - Bank Account
6573
6753
  * * `company` - Company
@@ -6592,14 +6772,14 @@ export type AdminUpdateServicePermission = {
6592
6772
  * * `user` - User
6593
6773
  * * `webhook` - Webhook
6594
6774
  */
6595
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
6775
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
6596
6776
  /**
6597
6777
  * * `view` - View
6598
6778
  * * `add` - Add
6599
6779
  * * `change` - Change
6600
6780
  * * `delete` - Delete
6601
6781
  */
6602
- level: 'view' | 'add' | 'change' | 'delete';
6782
+ readonly level: 'view' | 'add' | 'change' | 'delete';
6603
6783
  };
6604
6784
 
6605
6785
  export type AdminUpdateServicePermissionResponse = {
@@ -6670,10 +6850,11 @@ export type AdminUpdateUserDocumentRequest = {
6670
6850
  * * `obsolete` - Obsolete
6671
6851
  * * `declined` - Declined
6672
6852
  * * `pending` - Pending
6853
+ * * `paused` - Paused
6673
6854
  * * `incomplete` - Incomplete
6674
6855
  * * `verified` - Verified
6675
6856
  */
6676
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
6857
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
6677
6858
  metadata?: {
6678
6859
  [key: string]: unknown;
6679
6860
  } | null;
@@ -7238,10 +7419,11 @@ export type AdminUpdateUserInfoRequest = {
7238
7419
  * * `obsolete` - Obsolete
7239
7420
  * * `declined` - Declined
7240
7421
  * * `pending` - Pending
7422
+ * * `paused` - Paused
7241
7423
  * * `incomplete` - Incomplete
7242
7424
  * * `verified` - Verified
7243
7425
  */
7244
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
7426
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
7245
7427
  deactivated?: boolean;
7246
7428
  /**
7247
7429
  * * `retaining` - Retaining
@@ -7543,10 +7725,11 @@ export type AdminUserAddress = {
7543
7725
  * * `obsolete` - Obsolete
7544
7726
  * * `declined` - Declined
7545
7727
  * * `pending` - Pending
7728
+ * * `paused` - Paused
7546
7729
  * * `incomplete` - Incomplete
7547
7730
  * * `verified` - Verified
7548
7731
  */
7549
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
7732
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
7550
7733
  archived?: boolean;
7551
7734
  readonly created: number;
7552
7735
  readonly updated: number;
@@ -7828,10 +8011,11 @@ export type AdminUserAddressRequest = {
7828
8011
  * * `obsolete` - Obsolete
7829
8012
  * * `declined` - Declined
7830
8013
  * * `pending` - Pending
8014
+ * * `paused` - Paused
7831
8015
  * * `incomplete` - Incomplete
7832
8016
  * * `verified` - Verified
7833
8017
  */
7834
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
8018
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
7835
8019
  archived?: boolean;
7836
8020
  };
7837
8021
 
@@ -7853,6 +8037,7 @@ export type AdminUserBankAccount = {
7853
8037
  owner?: BankOwner | null;
7854
8038
  number?: string | null;
7855
8039
  type?: string | null;
8040
+ payment_method?: string | null;
7856
8041
  /**
7857
8042
  * * `individual` - Individual
7858
8043
  * * `business` - Business
@@ -7872,15 +8057,17 @@ export type AdminUserBankAccount = {
7872
8057
  check_digit?: string | null;
7873
8058
  pix_key?: string | null;
7874
8059
  br_code?: string | null;
8060
+ sort_code?: string | null;
7875
8061
  readonly code: string | null;
7876
8062
  /**
7877
8063
  * * `obsolete` - Obsolete
7878
8064
  * * `declined` - Declined
7879
8065
  * * `pending` - Pending
8066
+ * * `paused` - Paused
7880
8067
  * * `incomplete` - Incomplete
7881
8068
  * * `verified` - Verified
7882
8069
  */
7883
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
8070
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
7884
8071
  metadata?: {
7885
8072
  [key: string]: unknown;
7886
8073
  } | null;
@@ -7937,6 +8124,7 @@ export type AdminUserBankAccountRequest = {
7937
8124
  owner?: BankOwnerRequest | null;
7938
8125
  number?: string | null;
7939
8126
  type?: string | null;
8127
+ payment_method?: string | null;
7940
8128
  /**
7941
8129
  * * `individual` - Individual
7942
8130
  * * `business` - Business
@@ -7956,14 +8144,16 @@ export type AdminUserBankAccountRequest = {
7956
8144
  check_digit?: string | null;
7957
8145
  pix_key?: string | null;
7958
8146
  br_code?: string | null;
8147
+ sort_code?: string | null;
7959
8148
  /**
7960
8149
  * * `obsolete` - Obsolete
7961
8150
  * * `declined` - Declined
7962
8151
  * * `pending` - Pending
8152
+ * * `paused` - Paused
7963
8153
  * * `incomplete` - Incomplete
7964
8154
  * * `verified` - Verified
7965
8155
  */
7966
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
8156
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
7967
8157
  metadata?: {
7968
8158
  [key: string]: unknown;
7969
8159
  } | null;
@@ -8529,10 +8719,11 @@ export type AdminUserDocument = {
8529
8719
  * * `obsolete` - Obsolete
8530
8720
  * * `declined` - Declined
8531
8721
  * * `pending` - Pending
8722
+ * * `paused` - Paused
8532
8723
  * * `incomplete` - Incomplete
8533
8724
  * * `verified` - Verified
8534
8725
  */
8535
- status: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
8726
+ readonly status: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
8536
8727
  readonly metadata: {
8537
8728
  [key: string]: unknown;
8538
8729
  } | null;
@@ -9146,10 +9337,11 @@ export type AdminUserInfo = {
9146
9337
  * * `obsolete` - Obsolete
9147
9338
  * * `declined` - Declined
9148
9339
  * * `pending` - Pending
9340
+ * * `paused` - Paused
9149
9341
  * * `incomplete` - Incomplete
9150
9342
  * * `verified` - Verified
9151
9343
  */
9152
- status: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
9344
+ readonly status: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
9153
9345
  readonly created: number;
9154
9346
  readonly updated: number;
9155
9347
  deactivated?: boolean;
@@ -9175,7 +9367,7 @@ export type AdminUserLegalTerm = {
9175
9367
  * * `system` - System
9176
9368
  * * `company` - Company
9177
9369
  */
9178
- type: 'system' | 'company';
9370
+ readonly type: 'system' | 'company';
9179
9371
  name: string;
9180
9372
  description?: string | null;
9181
9373
  readonly versions: Array<AdminReducedUserLegalTermVersion>;
@@ -9262,12 +9454,13 @@ export type AdminUserPermission = {
9262
9454
  * * `admin` - Admin
9263
9455
  * * `user` - User
9264
9456
  */
9265
- section: 'system' | 'admin' | 'user';
9457
+ readonly section: 'system' | 'admin' | 'user';
9266
9458
  /**
9267
9459
  * * `accesscontrolrule` - Access Control Rule
9268
9460
  * * `account` - Account
9269
9461
  * * `accountdefinition` - Account Definition
9270
9462
  * * `address` - Address
9463
+ * * `alert` - Alert
9271
9464
  * * `currency` - Currency
9272
9465
  * * `bankaccount` - Bank Account
9273
9466
  * * `company` - Company
@@ -9292,14 +9485,14 @@ export type AdminUserPermission = {
9292
9485
  * * `user` - User
9293
9486
  * * `webhook` - Webhook
9294
9487
  */
9295
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
9488
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
9296
9489
  /**
9297
9490
  * * `view` - View
9298
9491
  * * `add` - Add
9299
9492
  * * `change` - Change
9300
9493
  * * `delete` - Delete
9301
9494
  */
9302
- level: 'view' | 'add' | 'change' | 'delete';
9495
+ readonly level: 'view' | 'add' | 'change' | 'delete';
9303
9496
  properties?: {
9304
9497
  [key: string]: unknown;
9305
9498
  } | null;
@@ -9350,10 +9543,11 @@ export type AdminUserWalletAccount = {
9350
9543
  * * `obsolete` - Obsolete
9351
9544
  * * `declined` - Declined
9352
9545
  * * `pending` - Pending
9546
+ * * `paused` - Paused
9353
9547
  * * `incomplete` - Incomplete
9354
9548
  * * `verified` - Verified
9355
9549
  */
9356
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
9550
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
9357
9551
  readonly currencies: Array<ReducedAsset>;
9358
9552
  archived?: boolean;
9359
9553
  /**
@@ -9420,10 +9614,11 @@ export type AdminUserWalletAccountRequest = {
9420
9614
  * * `obsolete` - Obsolete
9421
9615
  * * `declined` - Declined
9422
9616
  * * `pending` - Pending
9617
+ * * `paused` - Paused
9423
9618
  * * `incomplete` - Incomplete
9424
9619
  * * `verified` - Verified
9425
9620
  */
9426
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
9621
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
9427
9622
  archived?: boolean;
9428
9623
  /**
9429
9624
  * * `withdraw` - Withdraw
@@ -9483,8 +9678,10 @@ export type AdminWebhook = {
9483
9678
  * * `transaction.transition.create` - Transaction Transition Create
9484
9679
  * * `transaction.transition.update` - Transaction Transition Update
9485
9680
  * * `mfa.sms.verify` - Mfa Sms Verify
9681
+ * * `alert.create` - Alert Create
9682
+ * * `alert.update` - Alert Update
9486
9683
  */
9487
- event: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify';
9684
+ event: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | 'alert.create' | 'alert.update';
9488
9685
  secret?: string;
9489
9686
  condition?: string | null;
9490
9687
  enabled?: boolean;
@@ -9574,13 +9771,13 @@ export type AuthenticatorChallenge = {
9574
9771
  * * `authorization` - Authorization
9575
9772
  * * `setup` - Setup
9576
9773
  */
9577
- type: 'authentication' | 'authorization' | 'setup';
9774
+ readonly type: 'authentication' | 'authorization' | 'setup';
9578
9775
  /**
9579
9776
  * * `ephemeral` - Ephemeral
9580
9777
  * * `durable` - Durable
9581
9778
  * * `permanent` - Permanent
9582
9779
  */
9583
- durability: 'ephemeral' | 'durable' | 'permanent';
9780
+ readonly durability: 'ephemeral' | 'durable' | 'permanent';
9584
9781
  readonly authenticator_types: Array<'totp' | 'sms' | 'static'>;
9585
9782
  readonly created: number;
9586
9783
  };
@@ -10799,6 +10996,7 @@ export type CreatePermissionRequest = {
10799
10996
  * * `account` - Account
10800
10997
  * * `accountdefinition` - Account Definition
10801
10998
  * * `address` - Address
10999
+ * * `alert` - Alert
10802
11000
  * * `currency` - Currency
10803
11001
  * * `bankaccount` - Bank Account
10804
11002
  * * `company` - Company
@@ -10823,7 +11021,7 @@ export type CreatePermissionRequest = {
10823
11021
  * * `user` - User
10824
11022
  * * `webhook` - Webhook
10825
11023
  */
10826
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
11024
+ type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
10827
11025
  /**
10828
11026
  * * `view` - View
10829
11027
  * * `add` - Add
@@ -11456,10 +11654,11 @@ export type ExtendedUserInfo = {
11456
11654
  * * `obsolete` - Obsolete
11457
11655
  * * `declined` - Declined
11458
11656
  * * `pending` - Pending
11657
+ * * `paused` - Paused
11459
11658
  * * `incomplete` - Incomplete
11460
11659
  * * `verified` - Verified
11461
11660
  */
11462
- status: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
11661
+ readonly status: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
11463
11662
  readonly created: number;
11464
11663
  readonly updated: number;
11465
11664
  settings: UserSettings;
@@ -11488,12 +11687,13 @@ export type GroupPermission = {
11488
11687
  * * `admin` - Admin
11489
11688
  * * `user` - User
11490
11689
  */
11491
- section: 'system' | 'admin' | 'user';
11690
+ readonly section: 'system' | 'admin' | 'user';
11492
11691
  /**
11493
11692
  * * `accesscontrolrule` - Access Control Rule
11494
11693
  * * `account` - Account
11495
11694
  * * `accountdefinition` - Account Definition
11496
11695
  * * `address` - Address
11696
+ * * `alert` - Alert
11497
11697
  * * `currency` - Currency
11498
11698
  * * `bankaccount` - Bank Account
11499
11699
  * * `company` - Company
@@ -11518,14 +11718,14 @@ export type GroupPermission = {
11518
11718
  * * `user` - User
11519
11719
  * * `webhook` - Webhook
11520
11720
  */
11521
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
11721
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
11522
11722
  /**
11523
11723
  * * `view` - View
11524
11724
  * * `add` - Add
11525
11725
  * * `change` - Change
11526
11726
  * * `delete` - Delete
11527
11727
  */
11528
- level: 'view' | 'add' | 'change' | 'delete';
11728
+ readonly level: 'view' | 'add' | 'change' | 'delete';
11529
11729
  readonly properties: {
11530
11730
  [key: string]: unknown;
11531
11731
  };
@@ -11676,7 +11876,7 @@ export type GroupTierRequirementSetItem = {
11676
11876
  /**
11677
11877
  * * `resource` - Resource
11678
11878
  */
11679
- type: 'resource';
11879
+ readonly type: 'resource';
11680
11880
  rule: GroupTierRequirementSetItemRule;
11681
11881
  name?: string | null;
11682
11882
  description?: string | null;
@@ -11883,6 +12083,18 @@ export type PaginatedAdminAccountListResponse = {
11883
12083
  data: PaginatedAdminAccountList;
11884
12084
  };
11885
12085
 
12086
+ export type PaginatedAdminAlertList = {
12087
+ count?: number;
12088
+ next?: string | null;
12089
+ previous?: string | null;
12090
+ results?: Array<AdminAlert>;
12091
+ };
12092
+
12093
+ export type PaginatedAdminAlertListResponse = {
12094
+ status: string;
12095
+ data: PaginatedAdminAlertList;
12096
+ };
12097
+
11886
12098
  export type PaginatedAdminAssetList = {
11887
12099
  count?: number;
11888
12100
  next?: string | null;
@@ -12512,6 +12724,7 @@ export type PatchedAdminCompanyBankAccountRequest = {
12512
12724
  name?: string | null;
12513
12725
  number?: string | null;
12514
12726
  type?: string | null;
12727
+ payment_method?: string | null;
12515
12728
  bank_name?: string | null;
12516
12729
  bank_code?: string | null;
12517
12730
  bank_currency?: string | null;
@@ -12525,6 +12738,7 @@ export type PatchedAdminCompanyBankAccountRequest = {
12525
12738
  check_digit?: string | null;
12526
12739
  pix_key?: string | null;
12527
12740
  br_code?: string | null;
12741
+ sort_code?: string | null;
12528
12742
  metadata?: {
12529
12743
  [key: string]: unknown;
12530
12744
  } | null;
@@ -12944,10 +13158,11 @@ export type PatchedAdminCryptoAccountRequest = {
12944
13158
  * * `obsolete` - Obsolete
12945
13159
  * * `declined` - Declined
12946
13160
  * * `pending` - Pending
13161
+ * * `paused` - Paused
12947
13162
  * * `incomplete` - Incomplete
12948
13163
  * * `verified` - Verified
12949
13164
  */
12950
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
13165
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
12951
13166
  archived?: boolean;
12952
13167
  /**
12953
13168
  * * `withdraw` - Withdraw
@@ -13013,6 +13228,40 @@ export type PatchedAdminEmailRequest = {
13013
13228
  archived?: boolean;
13014
13229
  };
13015
13230
 
13231
+ /**
13232
+ * A ModelSerializer that takes additional arguments for
13233
+ * "fields", "omit" and "expand" in order to
13234
+ * control which fields are displayed, and whether to replace simple
13235
+ * values with complex, nested serializations
13236
+ */
13237
+ export type PatchedAdminExtendedAlertRequest = {
13238
+ name?: string;
13239
+ description?: string | null;
13240
+ /**
13241
+ * * `info` - Info
13242
+ * * `low` - Low
13243
+ * * `medium` - Medium
13244
+ * * `high` - High
13245
+ * * `critical` - Critical
13246
+ */
13247
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
13248
+ /**
13249
+ * * `open` - Open
13250
+ * * `assigned` - Assigned
13251
+ * * `paused` - Paused
13252
+ * * `closed` - Closed
13253
+ * * `reopened` - Reopened
13254
+ */
13255
+ status?: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
13256
+ metadata?: {
13257
+ [key: string]: unknown;
13258
+ } | null;
13259
+ archived?: boolean;
13260
+ actions?: Array<{
13261
+ [key: string]: unknown;
13262
+ }>;
13263
+ };
13264
+
13016
13265
  /**
13017
13266
  * A ModelSerializer that takes additional arguments for
13018
13267
  * "fields", "omit" and "expand" in order to
@@ -13112,6 +13361,7 @@ export type PatchedAdminUpdateAssetRequest = {
13112
13361
  * values with complex, nested serializations
13113
13362
  */
13114
13363
  export type PatchedAdminUpdateAuthTokenRequest = {
13364
+ label?: string | null;
13115
13365
  expires?: number;
13116
13366
  };
13117
13367
 
@@ -13190,6 +13440,7 @@ export type PatchedAdminUpdateExtendedAccountRequest = {
13190
13440
  label?: string | null;
13191
13441
  primary?: boolean;
13192
13442
  recon?: boolean;
13443
+ hidden?: boolean;
13193
13444
  metadata?: {
13194
13445
  [key: string]: unknown;
13195
13446
  } | null;
@@ -13407,10 +13658,11 @@ export type PatchedAdminUpdateUserDocumentRequest = {
13407
13658
  * * `obsolete` - Obsolete
13408
13659
  * * `declined` - Declined
13409
13660
  * * `pending` - Pending
13661
+ * * `paused` - Paused
13410
13662
  * * `incomplete` - Incomplete
13411
13663
  * * `verified` - Verified
13412
13664
  */
13413
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
13665
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
13414
13666
  metadata?: {
13415
13667
  [key: string]: unknown;
13416
13668
  } | null;
@@ -13975,10 +14227,11 @@ export type PatchedAdminUpdateUserInfoRequest = {
13975
14227
  * * `obsolete` - Obsolete
13976
14228
  * * `declined` - Declined
13977
14229
  * * `pending` - Pending
14230
+ * * `paused` - Paused
13978
14231
  * * `incomplete` - Incomplete
13979
14232
  * * `verified` - Verified
13980
14233
  */
13981
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
14234
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
13982
14235
  deactivated?: boolean;
13983
14236
  /**
13984
14237
  * * `retaining` - Retaining
@@ -14278,10 +14531,11 @@ export type PatchedAdminUserAddressRequest = {
14278
14531
  * * `obsolete` - Obsolete
14279
14532
  * * `declined` - Declined
14280
14533
  * * `pending` - Pending
14534
+ * * `paused` - Paused
14281
14535
  * * `incomplete` - Incomplete
14282
14536
  * * `verified` - Verified
14283
14537
  */
14284
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
14538
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
14285
14539
  archived?: boolean;
14286
14540
  };
14287
14541
 
@@ -14296,6 +14550,7 @@ export type PatchedAdminUserBankAccountRequest = {
14296
14550
  owner?: BankOwnerRequest | null;
14297
14551
  number?: string | null;
14298
14552
  type?: string | null;
14553
+ payment_method?: string | null;
14299
14554
  /**
14300
14555
  * * `individual` - Individual
14301
14556
  * * `business` - Business
@@ -14315,14 +14570,16 @@ export type PatchedAdminUserBankAccountRequest = {
14315
14570
  check_digit?: string | null;
14316
14571
  pix_key?: string | null;
14317
14572
  br_code?: string | null;
14573
+ sort_code?: string | null;
14318
14574
  /**
14319
14575
  * * `obsolete` - Obsolete
14320
14576
  * * `declined` - Declined
14321
14577
  * * `pending` - Pending
14578
+ * * `paused` - Paused
14322
14579
  * * `incomplete` - Incomplete
14323
14580
  * * `verified` - Verified
14324
14581
  */
14325
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
14582
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
14326
14583
  metadata?: {
14327
14584
  [key: string]: unknown;
14328
14585
  } | null;
@@ -14371,10 +14628,11 @@ export type PatchedAdminUserWalletAccountRequest = {
14371
14628
  * * `obsolete` - Obsolete
14372
14629
  * * `declined` - Declined
14373
14630
  * * `pending` - Pending
14631
+ * * `paused` - Paused
14374
14632
  * * `incomplete` - Incomplete
14375
14633
  * * `verified` - Verified
14376
14634
  */
14377
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
14635
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
14378
14636
  archived?: boolean;
14379
14637
  /**
14380
14638
  * * `withdraw` - Withdraw
@@ -14428,8 +14686,10 @@ export type PatchedAdminWebhookRequest = {
14428
14686
  * * `transaction.transition.create` - Transaction Transition Create
14429
14687
  * * `transaction.transition.update` - Transaction Transition Update
14430
14688
  * * `mfa.sms.verify` - Mfa Sms Verify
14689
+ * * `alert.create` - Alert Create
14690
+ * * `alert.update` - Alert Update
14431
14691
  */
14432
- event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify';
14692
+ event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | 'alert.create' | 'alert.update';
14433
14693
  secret?: string;
14434
14694
  condition?: string | null;
14435
14695
  enabled?: boolean;
@@ -14478,12 +14738,13 @@ export type Permission = {
14478
14738
  * * `admin` - Admin
14479
14739
  * * `user` - User
14480
14740
  */
14481
- section: 'system' | 'admin' | 'user';
14741
+ readonly section: 'system' | 'admin' | 'user';
14482
14742
  /**
14483
14743
  * * `accesscontrolrule` - Access Control Rule
14484
14744
  * * `account` - Account
14485
14745
  * * `accountdefinition` - Account Definition
14486
14746
  * * `address` - Address
14747
+ * * `alert` - Alert
14487
14748
  * * `currency` - Currency
14488
14749
  * * `bankaccount` - Bank Account
14489
14750
  * * `company` - Company
@@ -14508,14 +14769,14 @@ export type Permission = {
14508
14769
  * * `user` - User
14509
14770
  * * `webhook` - Webhook
14510
14771
  */
14511
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
14772
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
14512
14773
  /**
14513
14774
  * * `view` - View
14514
14775
  * * `add` - Add
14515
14776
  * * `change` - Change
14516
14777
  * * `delete` - Delete
14517
14778
  */
14518
- level: 'view' | 'add' | 'change' | 'delete';
14779
+ readonly level: 'view' | 'add' | 'change' | 'delete';
14519
14780
  };
14520
14781
 
14521
14782
  export type PermissionResponse = {
@@ -14649,7 +14910,7 @@ export type ReducedCompany = {
14649
14910
  * * `test` - Test
14650
14911
  * * `production` - Production
14651
14912
  */
14652
- mode: 'test' | 'production';
14913
+ readonly mode: 'test' | 'production';
14653
14914
  };
14654
14915
 
14655
14916
  /**
@@ -14767,7 +15028,7 @@ export type ReducedService = {
14767
15028
  * * `public` - Public
14768
15029
  * * `private` - Private
14769
15030
  */
14770
- type: 'system' | 'public' | 'private';
15031
+ readonly type: 'system' | 'public' | 'private';
14771
15032
  };
14772
15033
 
14773
15034
  export type ReducedTransactionSubtype = {
@@ -14909,14 +15170,14 @@ export type TransactionSubtype = {
14909
15170
  * * `credit` - Credit
14910
15171
  * * `debit` - Debit
14911
15172
  */
14912
- tx_type: 'credit' | 'debit';
15173
+ readonly tx_type: 'credit' | 'debit';
14913
15174
  /**
14914
15175
  * * `partner` - Partner
14915
15176
  * * `single` - Single
14916
15177
  *
14917
15178
  * @deprecated
14918
15179
  */
14919
- usage_type: 'partner' | 'single' | null;
15180
+ readonly usage_type: 'partner' | 'single' | null;
14920
15181
  partner: ReducedTransactionSubtype;
14921
15182
  readonly created: number;
14922
15183
  readonly updated: number;
@@ -14966,12 +15227,13 @@ export type UserPermission = {
14966
15227
  * * `admin` - Admin
14967
15228
  * * `user` - User
14968
15229
  */
14969
- section: 'system' | 'admin' | 'user';
15230
+ readonly section: 'system' | 'admin' | 'user';
14970
15231
  /**
14971
15232
  * * `accesscontrolrule` - Access Control Rule
14972
15233
  * * `account` - Account
14973
15234
  * * `accountdefinition` - Account Definition
14974
15235
  * * `address` - Address
15236
+ * * `alert` - Alert
14975
15237
  * * `currency` - Currency
14976
15238
  * * `bankaccount` - Bank Account
14977
15239
  * * `company` - Company
@@ -14996,14 +15258,14 @@ export type UserPermission = {
14996
15258
  * * `user` - User
14997
15259
  * * `webhook` - Webhook
14998
15260
  */
14999
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
15261
+ readonly type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
15000
15262
  /**
15001
15263
  * * `view` - View
15002
15264
  * * `add` - Add
15003
15265
  * * `change` - Change
15004
15266
  * * `delete` - Delete
15005
15267
  */
15006
- level: 'view' | 'add' | 'change' | 'delete';
15268
+ readonly level: 'view' | 'add' | 'change' | 'delete';
15007
15269
  readonly properties: {
15008
15270
  [key: string]: unknown;
15009
15271
  };
@@ -15153,6 +15415,7 @@ export type AdminAccountWritable = {
15153
15415
  label?: string | null;
15154
15416
  primary?: boolean;
15155
15417
  recon?: boolean;
15418
+ hidden?: boolean;
15156
15419
  metadata?: {
15157
15420
  [key: string]: unknown;
15158
15421
  } | null;
@@ -15311,6 +15574,37 @@ export type AdminAccountResponseWritable = {
15311
15574
  data: AdminAccountWritable;
15312
15575
  };
15313
15576
 
15577
+ /**
15578
+ * A ModelSerializer that takes additional arguments for
15579
+ * "fields", "omit" and "expand" in order to
15580
+ * control which fields are displayed, and whether to replace simple
15581
+ * values with complex, nested serializations
15582
+ */
15583
+ export type AdminAlertWritable = {
15584
+ name: string;
15585
+ description?: string | null;
15586
+ /**
15587
+ * * `info` - Info
15588
+ * * `low` - Low
15589
+ * * `medium` - Medium
15590
+ * * `high` - High
15591
+ * * `critical` - Critical
15592
+ */
15593
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
15594
+ /**
15595
+ * * `open` - Open
15596
+ * * `assigned` - Assigned
15597
+ * * `paused` - Paused
15598
+ * * `closed` - Closed
15599
+ * * `reopened` - Reopened
15600
+ */
15601
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
15602
+ metadata?: {
15603
+ [key: string]: unknown;
15604
+ } | null;
15605
+ archived?: boolean;
15606
+ };
15607
+
15314
15608
  /**
15315
15609
  * A ModelSerializer that takes additional arguments for
15316
15610
  * "fields", "omit" and "expand" in order to
@@ -15699,6 +15993,7 @@ export type AdminCompanyBankAccountWritable = {
15699
15993
  name?: string | null;
15700
15994
  number?: string | null;
15701
15995
  type?: string | null;
15996
+ payment_method?: string | null;
15702
15997
  bank_name?: string | null;
15703
15998
  bank_code?: string | null;
15704
15999
  bank_currency?: string | null;
@@ -15712,6 +16007,7 @@ export type AdminCompanyBankAccountWritable = {
15712
16007
  check_digit?: string | null;
15713
16008
  pix_key?: string | null;
15714
16009
  br_code?: string | null;
16010
+ sort_code?: string | null;
15715
16011
  metadata?: {
15716
16012
  [key: string]: unknown;
15717
16013
  } | null;
@@ -15980,6 +16276,7 @@ export type AdminCreateAccountRequestWritable = {
15980
16276
  label?: string | null;
15981
16277
  primary?: boolean;
15982
16278
  recon?: boolean;
16279
+ hidden?: boolean;
15983
16280
  user?: string | null;
15984
16281
  metadata?: {
15985
16282
  [key: string]: unknown;
@@ -15987,6 +16284,42 @@ export type AdminCreateAccountRequestWritable = {
15987
16284
  archived?: boolean;
15988
16285
  };
15989
16286
 
16287
+ /**
16288
+ * A ModelSerializer that takes additional arguments for
16289
+ * "fields", "omit" and "expand" in order to
16290
+ * control which fields are displayed, and whether to replace simple
16291
+ * values with complex, nested serializations
16292
+ */
16293
+ export type AdminCreateAlertRequestWritable = {
16294
+ transaction?: string;
16295
+ user?: string;
16296
+ name: string;
16297
+ description?: string | null;
16298
+ /**
16299
+ * * `info` - Info
16300
+ * * `low` - Low
16301
+ * * `medium` - Medium
16302
+ * * `high` - High
16303
+ * * `critical` - Critical
16304
+ */
16305
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
16306
+ /**
16307
+ * * `open` - Open
16308
+ * * `assigned` - Assigned
16309
+ * * `paused` - Paused
16310
+ * * `closed` - Closed
16311
+ * * `reopened` - Reopened
16312
+ */
16313
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
16314
+ metadata?: {
16315
+ [key: string]: unknown;
16316
+ } | null;
16317
+ archived?: boolean;
16318
+ actions?: Array<{
16319
+ [key: string]: unknown;
16320
+ }>;
16321
+ };
16322
+
15990
16323
  /**
15991
16324
  * A ModelSerializer that takes additional arguments for
15992
16325
  * "fields", "omit" and "expand" in order to
@@ -16104,10 +16437,11 @@ export type AdminCreateCryptoAccountRequestWritable = {
16104
16437
  * * `obsolete` - Obsolete
16105
16438
  * * `declined` - Declined
16106
16439
  * * `pending` - Pending
16440
+ * * `paused` - Paused
16107
16441
  * * `incomplete` - Incomplete
16108
16442
  * * `verified` - Verified
16109
16443
  */
16110
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
16444
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
16111
16445
  archived?: boolean;
16112
16446
  /**
16113
16447
  * * `withdraw` - Withdraw
@@ -16252,6 +16586,7 @@ export type AdminCreateGroupPermissionRequestWritable = {
16252
16586
  * * `account` - Account
16253
16587
  * * `accountdefinition` - Account Definition
16254
16588
  * * `address` - Address
16589
+ * * `alert` - Alert
16255
16590
  * * `currency` - Currency
16256
16591
  * * `bankaccount` - Bank Account
16257
16592
  * * `company` - Company
@@ -16276,7 +16611,7 @@ export type AdminCreateGroupPermissionRequestWritable = {
16276
16611
  * * `user` - User
16277
16612
  * * `webhook` - Webhook
16278
16613
  */
16279
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
16614
+ type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
16280
16615
  /**
16281
16616
  * * `view` - View
16282
16617
  * * `add` - Add
@@ -16838,10 +17173,11 @@ export type AdminCreateUserAddressRequestWritable = {
16838
17173
  * * `obsolete` - Obsolete
16839
17174
  * * `declined` - Declined
16840
17175
  * * `pending` - Pending
17176
+ * * `paused` - Paused
16841
17177
  * * `incomplete` - Incomplete
16842
17178
  * * `verified` - Verified
16843
17179
  */
16844
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
17180
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
16845
17181
  archived?: boolean;
16846
17182
  };
16847
17183
 
@@ -16857,6 +17193,7 @@ export type AdminCreateUserBankAccountRequestWritable = {
16857
17193
  owner?: BankOwnerRequest | null;
16858
17194
  number?: string | null;
16859
17195
  type?: string | null;
17196
+ payment_method?: string | null;
16860
17197
  /**
16861
17198
  * * `individual` - Individual
16862
17199
  * * `business` - Business
@@ -16876,14 +17213,16 @@ export type AdminCreateUserBankAccountRequestWritable = {
16876
17213
  check_digit?: string | null;
16877
17214
  pix_key?: string | null;
16878
17215
  br_code?: string | null;
17216
+ sort_code?: string | null;
16879
17217
  /**
16880
17218
  * * `obsolete` - Obsolete
16881
17219
  * * `declined` - Declined
16882
17220
  * * `pending` - Pending
17221
+ * * `paused` - Paused
16883
17222
  * * `incomplete` - Incomplete
16884
17223
  * * `verified` - Verified
16885
17224
  */
16886
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
17225
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
16887
17226
  metadata?: {
16888
17227
  [key: string]: unknown;
16889
17228
  } | null;
@@ -16909,10 +17248,11 @@ export type AdminCreateUserDocumentRequestWritable = {
16909
17248
  * * `obsolete` - Obsolete
16910
17249
  * * `declined` - Declined
16911
17250
  * * `pending` - Pending
17251
+ * * `paused` - Paused
16912
17252
  * * `incomplete` - Incomplete
16913
17253
  * * `verified` - Verified
16914
17254
  */
16915
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
17255
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
16916
17256
  metadata?: {
16917
17257
  [key: string]: unknown;
16918
17258
  } | null;
@@ -17496,6 +17836,7 @@ export type AdminCreateUserPermissionRequestWritable = {
17496
17836
  * * `account` - Account
17497
17837
  * * `accountdefinition` - Account Definition
17498
17838
  * * `address` - Address
17839
+ * * `alert` - Alert
17499
17840
  * * `currency` - Currency
17500
17841
  * * `bankaccount` - Bank Account
17501
17842
  * * `company` - Company
@@ -17520,7 +17861,7 @@ export type AdminCreateUserPermissionRequestWritable = {
17520
17861
  * * `user` - User
17521
17862
  * * `webhook` - Webhook
17522
17863
  */
17523
- type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
17864
+ type: 'accesscontrolrule' | 'account' | 'accountdefinition' | 'address' | 'alert' | 'currency' | 'bankaccount' | 'company' | 'cryptoaccount' | 'device' | 'document' | 'email' | 'group' | 'jwt' | 'legalterm' | 'mfa' | 'mfarule' | 'mobile' | 'notification' | 'oauthclient' | 'permission' | 'request' | 'service' | 'token' | 'transaction' | 'transactionsubtypes' | 'user' | 'webhook';
17524
17865
  /**
17525
17866
  * * `view` - View
17526
17867
  * * `add` - Add
@@ -17559,10 +17900,11 @@ export type AdminCreateUserWalletAccountRequestWritable = {
17559
17900
  * * `obsolete` - Obsolete
17560
17901
  * * `declined` - Declined
17561
17902
  * * `pending` - Pending
17903
+ * * `paused` - Paused
17562
17904
  * * `incomplete` - Incomplete
17563
17905
  * * `verified` - Verified
17564
17906
  */
17565
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
17907
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
17566
17908
  archived?: boolean;
17567
17909
  /**
17568
17910
  * * `withdraw` - Withdraw
@@ -17599,10 +17941,11 @@ export type AdminCryptoAccountWritable = {
17599
17941
  * * `obsolete` - Obsolete
17600
17942
  * * `declined` - Declined
17601
17943
  * * `pending` - Pending
17944
+ * * `paused` - Paused
17602
17945
  * * `incomplete` - Incomplete
17603
17946
  * * `verified` - Verified
17604
17947
  */
17605
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
17948
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
17606
17949
  archived?: boolean;
17607
17950
  /**
17608
17951
  * * `withdraw` - Withdraw
@@ -17814,6 +18157,7 @@ export type AdminExtendedAccountWritable = {
17814
18157
  label?: string | null;
17815
18158
  primary?: boolean;
17816
18159
  recon?: boolean;
18160
+ hidden?: boolean;
17817
18161
  metadata?: {
17818
18162
  [key: string]: unknown;
17819
18163
  } | null;
@@ -17825,6 +18169,45 @@ export type AdminExtendedAccountResponseWritable = {
17825
18169
  data: AdminExtendedAccountWritable;
17826
18170
  };
17827
18171
 
18172
+ /**
18173
+ * A ModelSerializer that takes additional arguments for
18174
+ * "fields", "omit" and "expand" in order to
18175
+ * control which fields are displayed, and whether to replace simple
18176
+ * values with complex, nested serializations
18177
+ */
18178
+ export type AdminExtendedAlertWritable = {
18179
+ name: string;
18180
+ description?: string | null;
18181
+ /**
18182
+ * * `info` - Info
18183
+ * * `low` - Low
18184
+ * * `medium` - Medium
18185
+ * * `high` - High
18186
+ * * `critical` - Critical
18187
+ */
18188
+ priority?: 'info' | 'low' | 'medium' | 'high' | 'critical';
18189
+ /**
18190
+ * * `open` - Open
18191
+ * * `assigned` - Assigned
18192
+ * * `paused` - Paused
18193
+ * * `closed` - Closed
18194
+ * * `reopened` - Reopened
18195
+ */
18196
+ status: 'open' | 'assigned' | 'paused' | 'closed' | 'reopened';
18197
+ metadata?: {
18198
+ [key: string]: unknown;
18199
+ } | null;
18200
+ archived?: boolean;
18201
+ actions?: Array<{
18202
+ [key: string]: unknown;
18203
+ }>;
18204
+ };
18205
+
18206
+ export type AdminExtendedAlertResponseWritable = {
18207
+ status: string;
18208
+ data: AdminExtendedAlertWritable;
18209
+ };
18210
+
17828
18211
  export type AdminExtendedAuthTokenWritable = {
17829
18212
  [key: string]: unknown;
17830
18213
  };
@@ -17893,6 +18276,7 @@ export type AdminExtendedRequestWritable = {
17893
18276
  * * `accountdefinition` - Account Definition
17894
18277
  * * `accountdefinitiongroup` - Account Definition Group
17895
18278
  * * `accountdefinitiongroupcurrency` - Account Definition Group Currency
18279
+ * * `alert` - Alert
17896
18280
  * * `currency` - Currency
17897
18281
  * * `authenticator` - Authenticator
17898
18282
  * * `authenticatorchallenge` - Authenticator Challenge
@@ -17965,7 +18349,7 @@ export type AdminExtendedRequestWritable = {
17965
18349
  * * `webhooktask` - Webhook Task
17966
18350
  * * `webhookrequest` - Webhook Request
17967
18351
  */
17968
- resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
18352
+ resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'alert' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
17969
18353
  };
17970
18354
 
17971
18355
  export type AdminExtendedRequestResponseWritable = {
@@ -19593,6 +19977,7 @@ export type AdminRequestWritable = {
19593
19977
  * * `accountdefinition` - Account Definition
19594
19978
  * * `accountdefinitiongroup` - Account Definition Group
19595
19979
  * * `accountdefinitiongroupcurrency` - Account Definition Group Currency
19980
+ * * `alert` - Alert
19596
19981
  * * `currency` - Currency
19597
19982
  * * `authenticator` - Authenticator
19598
19983
  * * `authenticatorchallenge` - Authenticator Challenge
@@ -19665,7 +20050,7 @@ export type AdminRequestWritable = {
19665
20050
  * * `webhooktask` - Webhook Task
19666
20051
  * * `webhookrequest` - Webhook Request
19667
20052
  */
19668
- resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
20053
+ resource: 'accesscontrolrule' | 'account' | 'accountcurrency' | 'accountcurrencylimit' | 'accountcurrencyfee' | 'accountdefinition' | 'accountdefinitiongroup' | 'accountdefinitiongroupcurrency' | 'alert' | 'currency' | 'authenticator' | 'authenticatorchallenge' | 'authenticatorrule' | 'backgroundtask' | 'bankowneraddress' | 'bankbranchaddress' | 'company' | 'companyaddress' | 'companybankaccount' | 'companywalletaccount' | 'companyservice' | 'companynotification' | 'device' | 'deviceapp' | 'document' | 'documenttype' | 'export' | 'exportpage' | 'email' | 'group' | 'grouplimit' | 'groupfee' | 'grouppermission' | 'grouptier' | 'grouptierrequirement' | 'grouptierlimit' | 'grouptierfee' | 'grouptierrequirementsetitem' | 'grouptierrequirementset' | 'legalterm' | 'legaltermversion' | 'metric' | 'metric_schema' | 'metric_point' | 'mfa' | 'mfasmsdevice' | 'mfatotpdevice' | 'mfastaticdevice' | 'mfatokenverification' | 'mobile' | 'mobileconfirmation' | 'notification' | 'oauthclient' | 'oauthlink' | 'oauthsession' | 'oidckey' | 'permission' | 'recoverycode' | 'refresh_token' | 'request' | 'resourcerequirementrule' | 'service' | 'statement' | 'token' | 'transaction' | 'transactionfee' | 'transactionsubtype' | 'transactionmessage' | 'transactioncollection' | 'user' | 'useraddress' | 'userbankaccount' | 'userwalletaccount' | 'usercryptoaccount' | 'userlegaltermversion' | 'usermessage' | 'userpermission' | 'webhook' | 'webhooktask' | 'webhookrequest' | null;
19669
20054
  };
19670
20055
 
19671
20056
  /**
@@ -20112,10 +20497,11 @@ export type AdminUpdateUserDocumentRequestWritable = {
20112
20497
  * * `obsolete` - Obsolete
20113
20498
  * * `declined` - Declined
20114
20499
  * * `pending` - Pending
20500
+ * * `paused` - Paused
20115
20501
  * * `incomplete` - Incomplete
20116
20502
  * * `verified` - Verified
20117
20503
  */
20118
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
20504
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
20119
20505
  metadata?: {
20120
20506
  [key: string]: unknown;
20121
20507
  } | null;
@@ -20681,10 +21067,11 @@ export type AdminUpdateUserInfoRequestWritable = {
20681
21067
  * * `obsolete` - Obsolete
20682
21068
  * * `declined` - Declined
20683
21069
  * * `pending` - Pending
21070
+ * * `paused` - Paused
20684
21071
  * * `incomplete` - Incomplete
20685
21072
  * * `verified` - Verified
20686
21073
  */
20687
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
21074
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
20688
21075
  deactivated?: boolean;
20689
21076
  /**
20690
21077
  * * `retaining` - Retaining
@@ -20984,10 +21371,11 @@ export type AdminUserAddressWritable = {
20984
21371
  * * `obsolete` - Obsolete
20985
21372
  * * `declined` - Declined
20986
21373
  * * `pending` - Pending
21374
+ * * `paused` - Paused
20987
21375
  * * `incomplete` - Incomplete
20988
21376
  * * `verified` - Verified
20989
21377
  */
20990
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
21378
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
20991
21379
  archived?: boolean;
20992
21380
  };
20993
21381
 
@@ -21007,6 +21395,7 @@ export type AdminUserBankAccountWritable = {
21007
21395
  owner?: BankOwner | null;
21008
21396
  number?: string | null;
21009
21397
  type?: string | null;
21398
+ payment_method?: string | null;
21010
21399
  /**
21011
21400
  * * `individual` - Individual
21012
21401
  * * `business` - Business
@@ -21026,14 +21415,16 @@ export type AdminUserBankAccountWritable = {
21026
21415
  check_digit?: string | null;
21027
21416
  pix_key?: string | null;
21028
21417
  br_code?: string | null;
21418
+ sort_code?: string | null;
21029
21419
  /**
21030
21420
  * * `obsolete` - Obsolete
21031
21421
  * * `declined` - Declined
21032
21422
  * * `pending` - Pending
21423
+ * * `paused` - Paused
21033
21424
  * * `incomplete` - Incomplete
21034
21425
  * * `verified` - Verified
21035
21426
  */
21036
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
21427
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
21037
21428
  metadata?: {
21038
21429
  [key: string]: unknown;
21039
21430
  } | null;
@@ -21766,10 +22157,11 @@ export type AdminUserWalletAccountWritable = {
21766
22157
  * * `obsolete` - Obsolete
21767
22158
  * * `declined` - Declined
21768
22159
  * * `pending` - Pending
22160
+ * * `paused` - Paused
21769
22161
  * * `incomplete` - Incomplete
21770
22162
  * * `verified` - Verified
21771
22163
  */
21772
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
22164
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
21773
22165
  archived?: boolean;
21774
22166
  /**
21775
22167
  * * `withdraw` - Withdraw
@@ -21856,8 +22248,10 @@ export type AdminWebhookWritable = {
21856
22248
  * * `transaction.transition.create` - Transaction Transition Create
21857
22249
  * * `transaction.transition.update` - Transaction Transition Update
21858
22250
  * * `mfa.sms.verify` - Mfa Sms Verify
22251
+ * * `alert.create` - Alert Create
22252
+ * * `alert.update` - Alert Update
21859
22253
  */
21860
- event: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify';
22254
+ event: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'bank_account.delete' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'account.currency.create' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | 'alert.create' | 'alert.update';
21861
22255
  secret?: string;
21862
22256
  condition?: string | null;
21863
22257
  enabled?: boolean;
@@ -22736,6 +23130,18 @@ export type PaginatedAdminAccountListResponseWritable = {
22736
23130
  data: PaginatedAdminAccountListWritable;
22737
23131
  };
22738
23132
 
23133
+ export type PaginatedAdminAlertListWritable = {
23134
+ count?: number;
23135
+ next?: string | null;
23136
+ previous?: string | null;
23137
+ results?: Array<AdminAlertWritable>;
23138
+ };
23139
+
23140
+ export type PaginatedAdminAlertListResponseWritable = {
23141
+ status: string;
23142
+ data: PaginatedAdminAlertListWritable;
23143
+ };
23144
+
22739
23145
  export type PaginatedAdminAssetListWritable = {
22740
23146
  count?: number;
22741
23147
  next?: string | null;
@@ -23701,10 +24107,11 @@ export type PatchedAdminUpdateUserDocumentRequestWritable = {
23701
24107
  * * `obsolete` - Obsolete
23702
24108
  * * `declined` - Declined
23703
24109
  * * `pending` - Pending
24110
+ * * `paused` - Paused
23704
24111
  * * `incomplete` - Incomplete
23705
24112
  * * `verified` - Verified
23706
24113
  */
23707
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
24114
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
23708
24115
  metadata?: {
23709
24116
  [key: string]: unknown;
23710
24117
  } | null;
@@ -24270,10 +24677,11 @@ export type PatchedAdminUpdateUserInfoRequestWritable = {
24270
24677
  * * `obsolete` - Obsolete
24271
24678
  * * `declined` - Declined
24272
24679
  * * `pending` - Pending
24680
+ * * `paused` - Paused
24273
24681
  * * `incomplete` - Incomplete
24274
24682
  * * `verified` - Verified
24275
24683
  */
24276
- status?: 'obsolete' | 'declined' | 'pending' | 'incomplete' | 'verified';
24684
+ status?: 'obsolete' | 'declined' | 'pending' | 'paused' | 'incomplete' | 'verified';
24277
24685
  deactivated?: boolean;
24278
24686
  /**
24279
24687
  * * `retaining` - Retaining
@@ -24887,6 +25295,7 @@ export type AccountsListData = {
24887
25295
  currency?: string;
24888
25296
  definition?: string;
24889
25297
  group?: string;
25298
+ hidden?: boolean;
24890
25299
  name?: string;
24891
25300
  orderby?: string;
24892
25301
  /**
@@ -25353,6 +25762,101 @@ export type AccountsCurrenciesSettingsUpdateResponses = {
25353
25762
 
25354
25763
  export type AccountsCurrenciesSettingsUpdateResponse = AccountsCurrenciesSettingsUpdateResponses[keyof AccountsCurrenciesSettingsUpdateResponses];
25355
25764
 
25765
+ export type AlertsListData = {
25766
+ body?: never;
25767
+ path?: never;
25768
+ query?: {
25769
+ author?: string;
25770
+ created?: string;
25771
+ created__gt?: string;
25772
+ created__gte?: string;
25773
+ created__lt?: string;
25774
+ created__lte?: string;
25775
+ /**
25776
+ * A page number within the paginated result set.
25777
+ */
25778
+ page?: number;
25779
+ /**
25780
+ * Number of results to return per page.
25781
+ */
25782
+ page_size?: number;
25783
+ priority?: string;
25784
+ status?: string;
25785
+ transaction?: string;
25786
+ updated?: string;
25787
+ updated__gt?: string;
25788
+ updated__gte?: string;
25789
+ updated__lt?: string;
25790
+ updated__lte?: string;
25791
+ user?: string;
25792
+ };
25793
+ url: '/3/admin/alerts/';
25794
+ };
25795
+
25796
+ export type AlertsListResponses = {
25797
+ 200: PaginatedAdminAlertListResponse;
25798
+ };
25799
+
25800
+ export type AlertsListResponse = AlertsListResponses[keyof AlertsListResponses];
25801
+
25802
+ export type AlertsCreateData = {
25803
+ body: AdminCreateAlertRequestWritable;
25804
+ path?: never;
25805
+ query?: never;
25806
+ url: '/3/admin/alerts/';
25807
+ };
25808
+
25809
+ export type AlertsCreateResponses = {
25810
+ 201: AdminExtendedAlertResponse;
25811
+ };
25812
+
25813
+ export type AlertsCreateResponse = AlertsCreateResponses[keyof AlertsCreateResponses];
25814
+
25815
+ export type AlertsRetrieveData = {
25816
+ body?: never;
25817
+ path: {
25818
+ identifier: string;
25819
+ };
25820
+ query?: never;
25821
+ url: '/3/admin/alerts/{identifier}/';
25822
+ };
25823
+
25824
+ export type AlertsRetrieveResponses = {
25825
+ 200: AdminExtendedAlertResponse;
25826
+ };
25827
+
25828
+ export type AlertsRetrieveResponse = AlertsRetrieveResponses[keyof AlertsRetrieveResponses];
25829
+
25830
+ export type AlertsPartialUpdateData = {
25831
+ body?: PatchedAdminExtendedAlertRequest;
25832
+ path: {
25833
+ identifier: string;
25834
+ };
25835
+ query?: never;
25836
+ url: '/3/admin/alerts/{identifier}/';
25837
+ };
25838
+
25839
+ export type AlertsPartialUpdateResponses = {
25840
+ 200: AdminExtendedAlertResponse;
25841
+ };
25842
+
25843
+ export type AlertsPartialUpdateResponse = AlertsPartialUpdateResponses[keyof AlertsPartialUpdateResponses];
25844
+
25845
+ export type AlertsUpdateData = {
25846
+ body: AdminExtendedAlertRequest;
25847
+ path: {
25848
+ identifier: string;
25849
+ };
25850
+ query?: never;
25851
+ url: '/3/admin/alerts/{identifier}/';
25852
+ };
25853
+
25854
+ export type AlertsUpdateResponses = {
25855
+ 200: AdminExtendedAlertResponse;
25856
+ };
25857
+
25858
+ export type AlertsUpdateResponse = AlertsUpdateResponses[keyof AlertsUpdateResponses];
25859
+
25356
25860
  export type AuthDeactivateCreateData = {
25357
25861
  body: AdminDeactivateRequest;
25358
25862
  path?: never;
@@ -27621,6 +28125,11 @@ export type RequestsListData = {
27621
28125
  path?: never;
27622
28126
  query?: {
27623
28127
  content_type?: string;
28128
+ created?: string;
28129
+ created__gt?: string;
28130
+ created__gte?: string;
28131
+ created__lt?: string;
28132
+ created__lte?: string;
27624
28133
  key?: string;
27625
28134
  method?: string;
27626
28135
  method__in?: string;
@@ -27638,6 +28147,7 @@ export type RequestsListData = {
27638
28147
  resource_id?: string;
27639
28148
  scheme?: string;
27640
28149
  status_code?: number;
28150
+ token_key?: string;
27641
28151
  user?: string;
27642
28152
  };
27643
28153
  url: '/3/admin/requests/';
@@ -28599,6 +29109,7 @@ export type UsersListData = {
28599
29109
  email__contains?: string;
28600
29110
  first_name?: string;
28601
29111
  first_name__contains?: string;
29112
+ first_name__icontains?: string;
28602
29113
  group?: string;
28603
29114
  group__isnull?: boolean;
28604
29115
  id?: string;
@@ -28612,8 +29123,10 @@ export type UsersListData = {
28612
29123
  last_login__lt?: string | null;
28613
29124
  last_name?: string;
28614
29125
  last_name__contains?: string;
29126
+ last_name__icontains?: string;
28615
29127
  middle_name?: string;
28616
29128
  middle_name__contains?: string;
29129
+ middle_name__icontains?: string;
28617
29130
  mobile?: string;
28618
29131
  mobile__contains?: string;
28619
29132
  /**
@@ -30733,6 +31246,9 @@ export type UsersTokensListData = {
30733
31246
  created__lt?: string;
30734
31247
  created__lte?: string;
30735
31248
  expires__isnull?: boolean;
31249
+ group?: string;
31250
+ group__in?: string;
31251
+ group__section?: string;
30736
31252
  /**
30737
31253
  * A page number within the paginated result set.
30738
31254
  */
@@ -30814,7 +31330,7 @@ export type UsersTokensPartialUpdateResponses = {
30814
31330
  export type UsersTokensPartialUpdateResponse = UsersTokensPartialUpdateResponses[keyof UsersTokensPartialUpdateResponses];
30815
31331
 
30816
31332
  export type UsersTokensUpdateData = {
30817
- body: AdminUpdateAuthTokenRequest;
31333
+ body?: AdminUpdateAuthTokenRequest;
30818
31334
  path: {
30819
31335
  token_key: string;
30820
31336
  };