@dalmore/api-contracts 1.0.2 → 1.0.5

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 (295) hide show
  1. package/README.md +34 -55
  2. package/index.d.mts +17 -0
  3. package/index.d.ts +17 -0
  4. package/index.mjs +10970 -0
  5. package/package.json +10 -46
  6. package/common/helpers/index.ts +0 -205
  7. package/common/types/account-contact.types.ts +0 -98
  8. package/common/types/account-detail.types.ts +0 -27
  9. package/common/types/account-integration.types.ts +0 -143
  10. package/common/types/account-manager.types.ts +0 -124
  11. package/common/types/account.types.ts +0 -296
  12. package/common/types/activity.types.ts +0 -274
  13. package/common/types/address.types.ts +0 -41
  14. package/common/types/aic.types.ts +0 -246
  15. package/common/types/aml.types.ts +0 -18
  16. package/common/types/api-key-logs.types.ts +0 -66
  17. package/common/types/api-keys.types.ts +0 -69
  18. package/common/types/asset.types.ts +0 -338
  19. package/common/types/auth.types.ts +0 -370
  20. package/common/types/batch-jobs.types.ts +0 -150
  21. package/common/types/bonus-tier.types.ts +0 -147
  22. package/common/types/cart.types.ts +0 -18
  23. package/common/types/checklist-items.types.ts +0 -70
  24. package/common/types/checklist.types.ts +0 -97
  25. package/common/types/common.types.ts +0 -1520
  26. package/common/types/comply-advantage-api.types.ts +0 -316
  27. package/common/types/comply-advantage.types.ts +0 -25
  28. package/common/types/contact-us.types.ts +0 -107
  29. package/common/types/contract-helpers.ts +0 -205
  30. package/common/types/countries.types.ts +0 -375
  31. package/common/types/covered-person.types.ts +0 -274
  32. package/common/types/dashboard.types.ts +0 -799
  33. package/common/types/data-record.types.ts +0 -325
  34. package/common/types/data-room.types.ts +0 -242
  35. package/common/types/default-theme-config.types.ts +0 -87
  36. package/common/types/disbursement-adjustment.types.ts +0 -32
  37. package/common/types/disbursement-approval-user.types.ts +0 -100
  38. package/common/types/disbursement-review.types.ts +0 -110
  39. package/common/types/disbursement-transaction.types.ts +0 -72
  40. package/common/types/disbursements.types.ts +0 -310
  41. package/common/types/domain-filter.types.ts +0 -55
  42. package/common/types/email-theme.types.ts +0 -442
  43. package/common/types/entity.types.ts +0 -15
  44. package/common/types/error-responses.types.ts +0 -135
  45. package/common/types/escrow-account.types.ts +0 -104
  46. package/common/types/exchange-api-key.types.ts +0 -121
  47. package/common/types/exchange-import.types.ts +0 -36
  48. package/common/types/exchange-provider.types.ts +0 -329
  49. package/common/types/file.types.ts +0 -461
  50. package/common/types/health.types.ts +0 -29
  51. package/common/types/index.ts +0 -48
  52. package/common/types/individuals.types.ts +0 -554
  53. package/common/types/investor-account.types.ts +0 -1239
  54. package/common/types/investorAccountIdSchema.type.ts +0 -0
  55. package/common/types/investors-offering.types.ts +0 -65
  56. package/common/types/invite.types.ts +0 -133
  57. package/common/types/issuer-bank-account.types.ts +0 -107
  58. package/common/types/issuer-offering.types.ts +0 -306
  59. package/common/types/issuer-payment-method.types.ts +0 -341
  60. package/common/types/issuer.types.ts +0 -312
  61. package/common/types/job-item.types.ts +0 -119
  62. package/common/types/jobs.types.ts +0 -171
  63. package/common/types/kyb.types.ts +0 -53
  64. package/common/types/kyc.types.ts +0 -188
  65. package/common/types/legal-entity.types.ts +0 -185
  66. package/common/types/login-history.types.ts +0 -46
  67. package/common/types/mail-template.types.ts +0 -436
  68. package/common/types/north-cap-integration.types.ts +0 -190
  69. package/common/types/note.types.ts +0 -109
  70. package/common/types/notification.types.ts +0 -58
  71. package/common/types/notion-api.types.ts +0 -374
  72. package/common/types/notion-database.types.ts +0 -125
  73. package/common/types/notion-page.types.ts +0 -267
  74. package/common/types/offering-reports.types.ts +0 -153
  75. package/common/types/offering-submission.types.ts +0 -314
  76. package/common/types/offering.types.ts +0 -590
  77. package/common/types/page-revision.types.ts +0 -86
  78. package/common/types/page.types.ts +0 -436
  79. package/common/types/password.type.ts +0 -15
  80. package/common/types/payment-methods.types.ts +0 -298
  81. package/common/types/phone.type.ts +0 -27
  82. package/common/types/portfolio.types.ts +0 -50
  83. package/common/types/privacy-policy-and-tos.types.ts +0 -231
  84. package/common/types/queue.types.ts +0 -111
  85. package/common/types/registered-reps.types.ts +0 -25
  86. package/common/types/rejection-reasons.types.ts +0 -56
  87. package/common/types/review.types.ts +0 -133
  88. package/common/types/role.types.ts +0 -26
  89. package/common/types/secondary-customer.types.ts +0 -66
  90. package/common/types/secondary-issuer.types.ts +0 -50
  91. package/common/types/secondary-order.types.ts +0 -58
  92. package/common/types/secondary-security.types.ts +0 -60
  93. package/common/types/secondary-trade.entity.ts +0 -16
  94. package/common/types/secondary-trade.types.ts +0 -95
  95. package/common/types/secure-request.types.ts +0 -68
  96. package/common/types/signer.types.ts +0 -651
  97. package/common/types/site-link.types.ts +0 -166
  98. package/common/types/site-settings.types.ts +0 -726
  99. package/common/types/site.types.ts +0 -270
  100. package/common/types/sms.types.ts +0 -30
  101. package/common/types/state-machine.types.ts +0 -177
  102. package/common/types/states.types.ts +0 -163
  103. package/common/types/subdoc-preview.types.ts +0 -35
  104. package/common/types/task.types.ts +0 -258
  105. package/common/types/trade-adjustment.type.ts +0 -33
  106. package/common/types/trade-line-item.type.ts +0 -132
  107. package/common/types/trade.types.ts +0 -931
  108. package/common/types/transaction.types.ts +0 -198
  109. package/common/types/trusted-contact.types.ts +0 -122
  110. package/common/types/typography.types.ts +0 -75
  111. package/common/types/user-manual.types.ts +0 -290
  112. package/common/types/user-setting.types.ts +0 -133
  113. package/common/types/user.types.ts +0 -320
  114. package/common/types/webhook.types.ts +0 -588
  115. package/common/types/zip.type.ts +0 -36
  116. package/contracts/clients/accounts/index.ts +0 -61
  117. package/contracts/clients/aic/index.ts +0 -59
  118. package/contracts/clients/api-key-logs/index.ts +0 -53
  119. package/contracts/clients/api-keys/index.ts +0 -73
  120. package/contracts/clients/assets/index.ts +0 -102
  121. package/contracts/clients/auth/index.ts +0 -50
  122. package/contracts/clients/files/index.ts +0 -166
  123. package/contracts/clients/files-public/index.ts +0 -166
  124. package/contracts/clients/index.ts +0 -44
  125. package/contracts/clients/individuals/index.ts +0 -93
  126. package/contracts/clients/investor-accounts/index.ts +0 -93
  127. package/contracts/clients/issuers/index.ts +0 -94
  128. package/contracts/clients/legal-entities/index.ts +0 -93
  129. package/contracts/clients/offerings/index.ts +0 -117
  130. package/contracts/clients/secure-requests/index.ts +0 -34
  131. package/contracts/clients/sites/index.ts +0 -56
  132. package/contracts/clients/trades/index.ts +0 -122
  133. package/contracts/compliance/account-contacts/index.ts +0 -82
  134. package/contracts/compliance/account-managers/index.ts +0 -142
  135. package/contracts/compliance/accounts/index.ts +0 -187
  136. package/contracts/compliance/activities/index.ts +0 -55
  137. package/contracts/compliance/aic/index.ts +0 -60
  138. package/contracts/compliance/api-keys/index.ts +0 -91
  139. package/contracts/compliance/assets/index.ts +0 -122
  140. package/contracts/compliance/auth/index.ts +0 -134
  141. package/contracts/compliance/batch-jobs/index.ts +0 -62
  142. package/contracts/compliance/bonus-tiers/index.ts +0 -55
  143. package/contracts/compliance/checklist/index.ts +0 -87
  144. package/contracts/compliance/checklist-items/index.ts +0 -86
  145. package/contracts/compliance/covered-persons/index.ts +0 -97
  146. package/contracts/compliance/dashboard/index.ts +0 -111
  147. package/contracts/compliance/data-records/index.ts +0 -116
  148. package/contracts/compliance/data-rooms/index.ts +0 -113
  149. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  150. package/contracts/compliance/disbursement/index.ts +0 -165
  151. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  152. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  153. package/contracts/compliance/domain-filters/index.ts +0 -117
  154. package/contracts/compliance/email-themes/index.ts +0 -284
  155. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  156. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  157. package/contracts/compliance/exchange-imports/index.ts +0 -137
  158. package/contracts/compliance/files/index.ts +0 -267
  159. package/contracts/compliance/files-public/index.ts +0 -188
  160. package/contracts/compliance/health/index.ts +0 -26
  161. package/contracts/compliance/index.ts +0 -147
  162. package/contracts/compliance/individuals/index.ts +0 -57
  163. package/contracts/compliance/investor-accounts/index.ts +0 -141
  164. package/contracts/compliance/invites/index.ts +0 -137
  165. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  166. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  167. package/contracts/compliance/issuers/index.ts +0 -97
  168. package/contracts/compliance/job-items/index.ts +0 -58
  169. package/contracts/compliance/jobs/index.ts +0 -59
  170. package/contracts/compliance/kyb/index.ts +0 -54
  171. package/contracts/compliance/kyc/index.ts +0 -77
  172. package/contracts/compliance/legal-entities/index.ts +0 -57
  173. package/contracts/compliance/login-histories/index.ts +0 -37
  174. package/contracts/compliance/notes/index.ts +0 -69
  175. package/contracts/compliance/notion-databases/index.ts +0 -107
  176. package/contracts/compliance/notion-pages/index.ts +0 -105
  177. package/contracts/compliance/offering-reports/index.ts +0 -149
  178. package/contracts/compliance/offerings/index.ts +0 -233
  179. package/contracts/compliance/pages/index.ts +0 -178
  180. package/contracts/compliance/payment-methods/index.ts +0 -57
  181. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  182. package/contracts/compliance/review/index.ts +0 -169
  183. package/contracts/compliance/roles/index.ts +0 -34
  184. package/contracts/compliance/secondary-customers/index.ts +0 -77
  185. package/contracts/compliance/secondary-orders/index.ts +0 -60
  186. package/contracts/compliance/secondary-trades/index.ts +0 -100
  187. package/contracts/compliance/secure-requests/index.ts +0 -54
  188. package/contracts/compliance/signer/index.ts +0 -369
  189. package/contracts/compliance/site-links/index.ts +0 -128
  190. package/contracts/compliance/site-settings/index.ts +0 -669
  191. package/contracts/compliance/sites/index.ts +0 -56
  192. package/contracts/compliance/state-machine/index.ts +0 -94
  193. package/contracts/compliance/tasks/index.ts +0 -91
  194. package/contracts/compliance/third-parties/index.ts +0 -52
  195. package/contracts/compliance/trade-line-items/index.ts +0 -59
  196. package/contracts/compliance/trades/index.ts +0 -230
  197. package/contracts/compliance/transactions/index.ts +0 -161
  198. package/contracts/compliance/user-manuals/index.ts +0 -271
  199. package/contracts/compliance/user-settings/index.ts +0 -189
  200. package/contracts/compliance/users/index.ts +0 -200
  201. package/contracts/compliance/webhooks/index.ts +0 -41
  202. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  203. package/contracts/compliance-apikey/index.ts +0 -14
  204. package/contracts/index.ts +0 -6
  205. package/contracts/investors/account-contacts/index.ts +0 -58
  206. package/contracts/investors/aic/index.ts +0 -59
  207. package/contracts/investors/assets/index.ts +0 -61
  208. package/contracts/investors/auth/index.ts +0 -116
  209. package/contracts/investors/bonus-tiers/index.ts +0 -37
  210. package/contracts/investors/cart/index.ts +0 -75
  211. package/contracts/investors/contact-us/index.ts +0 -48
  212. package/contracts/investors/data-records/index.ts +0 -113
  213. package/contracts/investors/data-rooms/index.ts +0 -96
  214. package/contracts/investors/files/index.ts +0 -167
  215. package/contracts/investors/files-public/index.ts +0 -185
  216. package/contracts/investors/index.ts +0 -72
  217. package/contracts/investors/individuals/index.ts +0 -99
  218. package/contracts/investors/investor-accounts/index.ts +0 -110
  219. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  220. package/contracts/investors/issuers/index.ts +0 -30
  221. package/contracts/investors/legal-entities/index.ts +0 -93
  222. package/contracts/investors/notes/index.ts +0 -69
  223. package/contracts/investors/offerings/index.ts +0 -93
  224. package/contracts/investors/pages/index.ts +0 -88
  225. package/contracts/investors/payment-methods/index.ts +0 -149
  226. package/contracts/investors/portfolios/index.ts +0 -53
  227. package/contracts/investors/sites/index.ts +0 -96
  228. package/contracts/investors/tasks/index.ts +0 -111
  229. package/contracts/investors/trade-line-items/index.ts +0 -75
  230. package/contracts/investors/trades/index.ts +0 -114
  231. package/contracts/investors/transactions/index.ts +0 -37
  232. package/contracts/investors/trusted-contacts/index.ts +0 -93
  233. package/contracts/investors/user-manuals/index.ts +0 -62
  234. package/contracts/investors/user-settings/index.ts +0 -170
  235. package/contracts/investors/users/index.ts +0 -45
  236. package/contracts/investors/webhooks/index.ts +0 -30
  237. package/contracts/issuers/account-contacts/index.ts +0 -76
  238. package/contracts/issuers/account-integrations/index.ts +0 -97
  239. package/contracts/issuers/accounts/index.ts +0 -97
  240. package/contracts/issuers/activities/index.ts +0 -54
  241. package/contracts/issuers/aic/index.ts +0 -39
  242. package/contracts/issuers/api-key-logs/index.ts +0 -53
  243. package/contracts/issuers/api-keys/index.ts +0 -93
  244. package/contracts/issuers/assets/index.ts +0 -122
  245. package/contracts/issuers/auth/index.ts +0 -152
  246. package/contracts/issuers/bonus-tiers/index.ts +0 -55
  247. package/contracts/issuers/contact-us/index.ts +0 -48
  248. package/contracts/issuers/covered-persons/index.ts +0 -136
  249. package/contracts/issuers/dashboard/index.ts +0 -72
  250. package/contracts/issuers/data-records/index.ts +0 -257
  251. package/contracts/issuers/data-rooms/index.ts +0 -134
  252. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  253. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  254. package/contracts/issuers/disbursements/index.ts +0 -153
  255. package/contracts/issuers/email-themes/index.ts +0 -242
  256. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  257. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  258. package/contracts/issuers/files/index.ts +0 -166
  259. package/contracts/issuers/files-public/index.ts +0 -166
  260. package/contracts/issuers/health/index.ts +0 -24
  261. package/contracts/issuers/index.ts +0 -112
  262. package/contracts/issuers/investor-accounts/index.ts +0 -148
  263. package/contracts/issuers/invites/index.ts +0 -129
  264. package/contracts/issuers/issuer/index.ts +0 -94
  265. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  266. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  267. package/contracts/issuers/kyc/index.ts +0 -38
  268. package/contracts/issuers/login-histories/index.ts +0 -51
  269. package/contracts/issuers/notes/index.ts +0 -69
  270. package/contracts/issuers/offerings/index.ts +0 -206
  271. package/contracts/issuers/pages/index.ts +0 -138
  272. package/contracts/issuers/payment-methods/index.ts +0 -61
  273. package/contracts/issuers/portfolios/index.ts +0 -36
  274. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  275. package/contracts/issuers/review/index.ts +0 -63
  276. package/contracts/issuers/secondary-customers/index.ts +0 -55
  277. package/contracts/issuers/secondary-orders/index.ts +0 -57
  278. package/contracts/issuers/secondary-trades/index.ts +0 -57
  279. package/contracts/issuers/secure-requests/index.ts +0 -34
  280. package/contracts/issuers/site-links/index.ts +0 -116
  281. package/contracts/issuers/site-settings/index.ts +0 -585
  282. package/contracts/issuers/sites/index.ts +0 -32
  283. package/contracts/issuers/tasks/index.ts +0 -111
  284. package/contracts/issuers/trades/index.ts +0 -132
  285. package/contracts/issuers/transactions/index.ts +0 -158
  286. package/contracts/issuers/user-manuals/index.ts +0 -62
  287. package/contracts/issuers/user-settings/index.ts +0 -170
  288. package/contracts/issuers/users/index.ts +0 -126
  289. package/contracts/secondaries/accounts/index.ts +0 -58
  290. package/contracts/secondaries/index.ts +0 -23
  291. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  292. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  293. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  294. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  295. package/contracts/secondaries/secondary-trades/index.ts +0 -56
@@ -1,270 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import { TypeID } from 'typeid-js';
4
- import {
5
- AccountStatus,
6
- AccountZod,
7
- IPaginationMeta,
8
- UrlSchema,
9
- } from './common.types';
10
- import { accountIdSchema } from './account.types';
11
- import { fileIdSchema } from './file.types';
12
- import { IAsset } from './asset.types';
13
- import { GetInvestorAccountTypeSettingsZod } from './site-settings.types';
14
- import { InvestorPageResponseZod, pageIdSchema } from './page.types';
15
- import { ThemeFileType } from './common.types';
16
- import { IAccountContact } from './account-contact.types';
17
-
18
- export const sitesIdSchema = z.string().refine(
19
- (value) => {
20
- try {
21
- const tid = TypeID.fromString(value);
22
- return tid.getType() === 'site';
23
- } catch {
24
- return false;
25
- }
26
- },
27
- {
28
- message: `Invalid site ID format. Must be a valid TypeID with "site" prefix. Example: site_01j5y5ghx5fg68d663j1fvy2x7`,
29
- },
30
- );
31
-
32
- export const SiteZod = IBaseEntity.extend({
33
- id: sitesIdSchema,
34
- accountId: accountIdSchema.nullable(),
35
- account: AccountZod.nullable().optional(),
36
- title: z.string().nullable(),
37
- description: z.string().nullable(),
38
- keywords: z.string().nullable(),
39
- logo: z.lazy(() => fileIdSchema).nullable(),
40
- favicon: z.lazy(() => fileIdSchema).nullable(),
41
- backgroundImage: z.lazy(() => fileIdSchema).nullable(),
42
- domain: z.string(),
43
- customDomain: z.string().nullable(),
44
- enabled: z.boolean().default(false),
45
- message: z.string().nullable(),
46
- withPersonaThemeId: z.string().nullable(),
47
- gaIds: z.array(z.string()).nullable(),
48
- investorAccountTypes: z
49
- .object({
50
- individual: z.boolean(),
51
- joint: z.boolean(),
52
- entity: z.boolean(),
53
- retirement: z.boolean(),
54
- })
55
- .nullable(),
56
- tagline: z.string().nullable(),
57
- supportEmail: z.string(),
58
- senderEmail: z.string(),
59
- trackingPixelCode: z.string().nullable(),
60
- conversionPixelCode: z.string().nullable(),
61
- demoEmail: z.string().nullable(),
62
- demoPassword: z.string().nullable(),
63
- publicOfferings: z.boolean().default(false),
64
- publicPages: z.boolean().default(false),
65
- publicDataRooms: z.boolean().default(false),
66
- });
67
- export type SiteZod = z.infer<typeof SiteZod>;
68
-
69
- export const SitesParamSchema = z.object({
70
- id: sitesIdSchema,
71
- });
72
-
73
- export const SitesFiltersZod = z.object({
74
- url: z.string().optional(),
75
- accountId: accountIdSchema.optional(),
76
- enabled: z.preprocess(
77
- (val) =>
78
- val === 'true' || val === '1'
79
- ? true
80
- : val === 'false' || val === '0'
81
- ? false
82
- : val,
83
- z.boolean().optional(),
84
- ),
85
- });
86
-
87
- const sitesInclude = z.enum(['account']);
88
- export const SitesIncludeQuery = z.object({
89
- include: z
90
- .string()
91
- .optional()
92
- .transform((str) => (str ? str.split(',') : []))
93
- .refine(
94
- (includes) =>
95
- includes.every((include) =>
96
- sitesInclude.options.includes(include as any),
97
- ),
98
- {
99
- message: `Invalid include option provided. Valid options are: ${sitesInclude.options.join(',')}`,
100
- },
101
- )
102
- .openapi({
103
- example: `${sitesInclude.options.join(',')}`,
104
- }),
105
- });
106
- export interface SitesIncludeQuery extends z.infer<typeof SitesIncludeQuery> {}
107
-
108
- export const SitesPaginated = z.object({
109
- items: z.array(SiteZod),
110
- meta: IPaginationMeta,
111
- });
112
-
113
- /**
114
- * Zod schema for validating a DNS CNAME record response from Cloudflare's API.
115
- *
116
- * This schema defines the structure of a CNAME DNS record response from Cloudflare,
117
- * including metadata, settings, and record-specific details. It is based on the API
118
- * specification for DNS records.
119
- *
120
- * For more details on the API response structure, see:
121
- * @see {@link https://developers.cloudflare.com/api/resources/dns/subresources/records/models/cname_record/#(schema) Cloudflare CNAME Record Schema Documentation
122
- *
123
- ***/
124
- export const CloudflareRecordResponse = z.object({
125
- comment: z.string().optional(), // Comments or notes about the DNS record. This field has no effect on DNS responses.
126
- content: z.string().optional(), // A valid hostname. Must not match the record's name.
127
- name: z.string().optional(), // DNS record name (or @ for the zone apex) in Punycode.
128
- proxied: z.boolean().optional(), // Whether the record is receiving the performance and security benefits of Cloudflare.
129
- settings: z
130
- .object({
131
- flatten_cname: z.boolean().optional(), // If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
132
- ipv4_only: z.boolean().optional(), // When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
133
- ipv6_only: z.boolean().optional(), // When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
134
- })
135
- .optional(), // Settings for the DNS record.
136
- tags: z.array(z.string().optional()), // Custom tags for the DNS record. This field has no effect on DNS responses.
137
- ttl: z.number().optional(), // Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
138
- type: z.enum(['CNAME']).optional(), // Record type.
139
- id: z.string(), // Identifier
140
- created_on: z.string(), // When the record was created.
141
- meta: z.unknown().optional(), // Extra Cloudflare-specific information about the record,
142
- modified_on: z.string(), // When the record was last modified.
143
- proxiable: z.boolean(), // Whether the record can be proxied by Cloudflare or not.
144
- comment_modified_on: z.string().optional(), // When the record comment was last modified. Omitted if there is no comment.
145
- tags_modified_on: z.string().optional(), // When the record tags were last modified. Omitted if there are no tags.
146
- });
147
- export type CloudflareRecordResponse = z.infer<typeof CloudflareRecordResponse>;
148
-
149
- /**
150
- * Zod schema for validating Cloudflare API response information.
151
- *
152
- * This schema defines the structure of the response info object from Cloudflare APIs, including
153
- * a numeric code and a message string.
154
- *
155
- * @see {@link https://developers.cloudflare.com/api/resources/$shared/models/response_info/#(schema) Cloudflare API Response Info Schema}
156
- */
157
- export const CloudflareResponseInfoZod = z.object({
158
- code: z.number(),
159
- message: z.string(),
160
- });
161
-
162
- export type CloudflareResponseInfoZod = z.infer<
163
- typeof CloudflareResponseInfoZod
164
- >;
165
-
166
- /**
167
- * Zod schema for validating a response from the Cloudflare DNS Records API.
168
- *
169
- * For more details on the API response structure, see the Cloudflare documentation:
170
- * @see {@link https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/create/ Cloudflare DNS Records API - Create Method}
171
- */
172
- export const CloudflareResponseZod = z.object({
173
- errors: z.array(CloudflareResponseInfoZod),
174
- messages: z.array(CloudflareResponseInfoZod),
175
- success: z.boolean(),
176
- result: CloudflareRecordResponse,
177
- });
178
- export type CloudflareResponseZod = z.infer<typeof CloudflareResponseZod>;
179
-
180
- export enum OperationType {
181
- CREATE = 'CREATE',
182
- UPDATE = 'UPDATE',
183
- RETRIEVE = 'RETRIEVE',
184
- }
185
-
186
- export const SiteUrlsZod = z.object({
187
- backgroundImage: z.string().nullable(),
188
- favicon: z.string().nullable(),
189
- logo: z.string().nullable(),
190
- title: z.string().nullable(),
191
- description: z.string().nullable(),
192
- keywords: z.string().nullable(),
193
- withPersonaThemeId: z.string().nullable(),
194
- siteId: z.string().nullable(),
195
- tagline: z.string().nullable(),
196
- });
197
- export type SiteUrlsZod = z.infer<typeof SiteUrlsZod>;
198
-
199
- export const DownloadThemeFileZod = z.object({
200
- type: z.nativeEnum(ThemeFileType).openapi({ example: ThemeFileType.LIGHT }),
201
- url: UrlSchema,
202
- });
203
-
204
- export type DownloadThemeFileZod = z.infer<typeof DownloadThemeFileZod>;
205
-
206
- export const SiteUrlZod = z.object({
207
- url: UrlSchema,
208
- });
209
- export type SiteUrlZod = z.infer<typeof SiteUrlZod>;
210
-
211
- export const VerifyPasswordZod = z.object({
212
- password: z.string(),
213
- });
214
- export type VerifyPasswordZod = z.infer<typeof VerifyPasswordZod>;
215
-
216
- export const VerifyPasswordResponseZod = z.object({
217
- success: z.boolean(),
218
- });
219
- export type VerifyPasswordResponseZod = z.infer<
220
- typeof VerifyPasswordResponseZod
221
- >;
222
-
223
- export const SiteConfigsZod = z.object({
224
- id: z.string(),
225
- name: z.string(),
226
- accountId: accountIdSchema,
227
- withPersonaThemeId: z.string().nullable(),
228
- gaIds: z.array(z.string()).nullable(),
229
- heroAsset: z.lazy(() => IAsset).nullable(),
230
- investorAccountSettings: GetInvestorAccountTypeSettingsZod.nullable(),
231
- tagline: z.string().nullable(),
232
- senderEmail: z.string(),
233
- landingPageId: pageIdSchema.nullable(),
234
- landingPage: z.lazy(() => InvestorPageResponseZod).nullable(),
235
- trackingPixelCode: z.string().nullable(),
236
- conversionPixelCode: z.string().nullable(),
237
- publicOfferings: z.boolean().default(false),
238
- publicPages: z.boolean().default(false),
239
- publicDataRooms: z.boolean().default(false),
240
- themeCss: z.string().nullable().optional(),
241
- demoEmail: z.string().nullable(),
242
- demoPassword: z.string().nullable(),
243
- accountContacts: z.array(IAccountContact).nullable().optional(),
244
- status: z.nativeEnum(AccountStatus),
245
- });
246
- export type SiteConfigsZod = z.infer<typeof SiteConfigsZod>;
247
-
248
- /**
249
- * Cloudflare Turnstile server-side validation response schema.
250
- * Handles both successful and failed responses.
251
- *
252
- * @see {@link https://developers.cloudflare.com/turnstile/get-started/server-side-validation/ Cloudflare Turnstile Server-side Validation}
253
- */
254
- export const CloudflareTurnstileResponseZod = z.object({
255
- success: z.boolean(),
256
- 'error-codes': z.array(z.string()).optional(),
257
- challenge_ts: z.string().datetime().optional(),
258
- hostname: z.string().optional(),
259
- action: z.string().optional(),
260
- cdata: z.string().optional(),
261
- metadata: z
262
- .object({
263
- ephemeral_id: z.string(),
264
- })
265
- .optional(),
266
- });
267
-
268
- export type CloudflareTurnstileResponseZod = z.infer<
269
- typeof CloudflareTurnstileResponseZod
270
- >;
@@ -1,30 +0,0 @@
1
- import { z } from 'zod';
2
-
3
- /**
4
- * @description list of supported country codes.. Informs supported sms functionality.
5
- */
6
- export const SupportedCountryCodes = ['US'] as const;
7
-
8
- /**
9
- * @description list of supported country schemas. Informs supported sms functionality.
10
- */
11
- export const SupportedCountryCodesSchema = z.enum([...SupportedCountryCodes]);
12
-
13
- /**
14
- * @description list of supported two factor methods.
15
- */
16
- export enum TwoFactorMethod {
17
- NONE = 'NONE',
18
- AUTHENTICATOR = 'AUTHENTICATOR',
19
- SMS = 'SMS',
20
- }
21
-
22
- export const PhoneNumberData = z.object({
23
- countryCallingCode: z.string(),
24
- country: z.string(),
25
- nationalNumber: z.string(),
26
- number: z.string(),
27
- formatNational: z.string(),
28
- formatInternational: z.string(),
29
- });
30
- export type PhoneNumberData = z.infer<typeof PhoneNumberData>;
@@ -1,177 +0,0 @@
1
- import { z } from 'zod';
2
- import { AicZod } from './aic.types';
3
- import { FileZod } from './file.types';
4
- import {
5
- TradeStatus,
6
- TransactionType,
7
- TransactionStatus,
8
- } from './common.types';
9
- import { typeid } from 'typeid-js';
10
-
11
- export enum StateMachineType {
12
- AIC_VALIDATION = 'AIC_VALIDATION',
13
- FILE_REVIEW = 'FILE_REVIEW',
14
- FINALIZE_TRADE = 'FINALIZE_TRADE',
15
- }
16
-
17
- export enum StateMachineEvents {
18
- START = 'START',
19
- STEP_FORWARD = 'STEP_FORWARD',
20
- COMPLETE = 'COMPLETE',
21
- }
22
-
23
- export enum StateMachineTags {
24
- CAN_PROGRESS = 'CAN_PROGRESS',
25
- }
26
-
27
- export const BaseStateMachineStates = {
28
- IDLE: 'IDLE',
29
- COMPLETED: 'COMPLETED',
30
- DONE: 'DONE',
31
- } as const;
32
-
33
- export type BaseStateMachineStatesType = typeof BaseStateMachineStates;
34
-
35
- // Simplified schema for FINALIZE_TRADE state machine payload
36
- // Frontend sends minimal data, we transform it to Trade entity structure
37
- const FinalizeTradePayloadZod = z
38
- .object({
39
- txnChargedAmount: z.number(),
40
- totalAmount: z.number().nullable().optional(),
41
- tradeStatus: z.nativeEnum(TradeStatus),
42
- transactions: z
43
- .array(
44
- z.object({
45
- type: z.nativeEnum(TransactionType),
46
- status: z.nativeEnum(TransactionStatus),
47
- amount: z.number(),
48
- refundTransactions: z
49
- .array(
50
- z.object({
51
- type: z.nativeEnum(TransactionType),
52
- status: z.nativeEnum(TransactionStatus),
53
- amount: z.number(),
54
- }),
55
- )
56
- .optional()
57
- .nullable()
58
- .default([]),
59
- }),
60
- )
61
- .optional()
62
- .nullable()
63
- .default([]),
64
- })
65
- .transform((data) => {
66
- return {
67
- id: typeid('trade').toString(),
68
- txnChargedAmount: data.txnChargedAmount || null,
69
- tradeStatus: data.tradeStatus,
70
- totalAmount: data.txnChargedAmount || null,
71
- adjustments: [],
72
- transactions: (data.transactions || []).map((txn) => ({
73
- id: typeid('transaction').toString(),
74
- type: txn.type,
75
- status: txn.status,
76
- amount: txn.amount,
77
- tradeId: typeid('trade').toString(),
78
- refundTransactions: (txn.refundTransactions || []).map((refund) => ({
79
- id: typeid('refund_transaction').toString(),
80
- type: refund.type,
81
- status: refund.status,
82
- amount: refund.amount,
83
- transactionId: typeid('transaction').toString(),
84
- })),
85
- })),
86
- };
87
- });
88
- export type FinalizeTradePayloadZod = z.infer<typeof FinalizeTradePayloadZod>;
89
-
90
- export const CreateStateMachineConfigurationZod = z.discriminatedUnion('type', [
91
- z.object({
92
- name: z.string(),
93
- description: z.string(),
94
- type: z.literal(StateMachineType.AIC_VALIDATION),
95
- payload: AicZod,
96
- }),
97
- z.object({
98
- type: z.literal(StateMachineType.FILE_REVIEW),
99
- name: z.string(),
100
- description: z.string(),
101
- payload: FileZod,
102
- }),
103
- z.object({
104
- type: z.literal(StateMachineType.FINALIZE_TRADE),
105
- name: z.string(),
106
- description: z.string(),
107
- payload: FinalizeTradePayloadZod,
108
- }),
109
- ]);
110
- export type CreateStateMachineConfigurationZod = z.infer<
111
- typeof CreateStateMachineConfigurationZod
112
- >;
113
-
114
- export const StateMachineConfigurationZod = z.object({
115
- id: z.string(),
116
- name: z.string(),
117
- description: z.string(),
118
- type: z.nativeEnum(StateMachineType),
119
- payload: z.record(z.string(), z.any()),
120
- });
121
-
122
- export type StateMachineConfigurationZod = z.infer<
123
- typeof StateMachineConfigurationZod
124
- >;
125
-
126
- export const StartStateMachineZod = z.discriminatedUnion('type', [
127
- z.object({
128
- type: z.literal(StateMachineType.AIC_VALIDATION),
129
- payload: AicZod,
130
- debugMode: z.boolean().optional().default(false),
131
- }),
132
- z.object({
133
- type: z.literal(StateMachineType.FILE_REVIEW),
134
- payload: FileZod,
135
- debugMode: z.boolean().optional().default(false),
136
- }),
137
- z.object({
138
- type: z.literal(StateMachineType.FINALIZE_TRADE),
139
- payload: FinalizeTradePayloadZod,
140
- debugMode: z.boolean().optional().default(false),
141
- }),
142
- ]);
143
- export type StartStateMachineZod = z.infer<typeof StartStateMachineZod>;
144
-
145
- export const DebugStateMachineZod = z.object({
146
- sessionId: z.string(),
147
- });
148
- export type DebugStateMachineZod = z.infer<typeof DebugStateMachineZod>;
149
-
150
- export const StateMachineTransitionZod = z.object({
151
- to: z.string(),
152
- from: z.string(),
153
- timestamp: z.string(),
154
- });
155
- export type StateMachineTransitionZod = z.infer<
156
- typeof StateMachineTransitionZod
157
- >;
158
-
159
- export const StateMachineResponseZod = z.object({
160
- sessionId: z.string(),
161
- currentState: z.string(),
162
- error: z.string().optional(),
163
- transitionHistory: z.array(StateMachineTransitionZod),
164
- isCompleted: z.boolean(),
165
- isDebugMode: z.boolean(),
166
- canTransition: z.boolean(),
167
- });
168
- export type StateMachineResponseZod = z.infer<typeof StateMachineResponseZod>;
169
-
170
- export const StateMachineSessionZod = z.object({
171
- id: z.string(),
172
- type: z.nativeEnum(StateMachineType),
173
- persistedSnapshot: z.string().nullable(),
174
- payload: z.record(z.string(), z.any()),
175
- debugMode: z.boolean(),
176
- });
177
- export type StateMachineSessionZod = z.infer<typeof StateMachineSessionZod>;
@@ -1,163 +0,0 @@
1
- import { z } from 'zod';
2
- import { CountryCode, CountryEnumSchema } from './countries.types';
3
-
4
- const StateSchema = z.object({
5
- code: z.string().length(2),
6
- name: z.string(),
7
- });
8
- type State = z.infer<typeof StateSchema>;
9
-
10
- const StatesSchema = z.array(StateSchema);
11
-
12
- export const states: State[] = [
13
- { code: 'AL', name: 'Alabama' },
14
- { code: 'AK', name: 'Alaska' },
15
- { code: 'AZ', name: 'Arizona' },
16
- { code: 'AR', name: 'Arkansas' },
17
- { code: 'CA', name: 'California' },
18
- { code: 'CO', name: 'Colorado' },
19
- { code: 'CT', name: 'Connecticut' },
20
- { code: 'DE', name: 'Delaware' },
21
- { code: 'FL', name: 'Florida' },
22
- { code: 'GA', name: 'Georgia' },
23
- { code: 'HI', name: 'Hawaii' },
24
- { code: 'ID', name: 'Idaho' },
25
- { code: 'IL', name: 'Illinois' },
26
- { code: 'IN', name: 'Indiana' },
27
- { code: 'IA', name: 'Iowa' },
28
- { code: 'KS', name: 'Kansas' },
29
- { code: 'KY', name: 'Kentucky' },
30
- { code: 'LA', name: 'Louisiana' },
31
- { code: 'ME', name: 'Maine' },
32
- { code: 'MD', name: 'Maryland' },
33
- { code: 'MA', name: 'Massachusetts' },
34
- { code: 'MI', name: 'Michigan' },
35
- { code: 'MN', name: 'Minnesota' },
36
- { code: 'MS', name: 'Mississippi' },
37
- { code: 'MO', name: 'Missouri' },
38
- { code: 'MT', name: 'Montana' },
39
- { code: 'NE', name: 'Nebraska' },
40
- { code: 'NV', name: 'Nevada' },
41
- { code: 'NH', name: 'New Hampshire' },
42
- { code: 'NJ', name: 'New Jersey' },
43
- { code: 'NM', name: 'New Mexico' },
44
- { code: 'NY', name: 'New York' },
45
- { code: 'NC', name: 'North Carolina' },
46
- { code: 'ND', name: 'North Dakota' },
47
- { code: 'OH', name: 'Ohio' },
48
- { code: 'OK', name: 'Oklahoma' },
49
- { code: 'OR', name: 'Oregon' },
50
- { code: 'PA', name: 'Pennsylvania' },
51
- { code: 'RI', name: 'Rhode Island' },
52
- { code: 'SC', name: 'South Carolina' },
53
- { code: 'SD', name: 'South Dakota' },
54
- { code: 'TN', name: 'Tennessee' },
55
- { code: 'TX', name: 'Texas' },
56
- { code: 'UT', name: 'Utah' },
57
- { code: 'VT', name: 'Vermont' },
58
- { code: 'VA', name: 'Virginia' },
59
- { code: 'WA', name: 'Washington' },
60
- { code: 'WV', name: 'West Virginia' },
61
- { code: 'WI', name: 'Wisconsin' },
62
- { code: 'WY', name: 'Wyoming' },
63
- ];
64
- const validatedStates = StatesSchema.parse(states);
65
-
66
- const stateEnum = states.reduce(
67
- (acc, state) => {
68
- acc[state.code] = state.code;
69
- return acc;
70
- },
71
- {} as Record<string, string>,
72
- );
73
-
74
- export const StateCode = Object.freeze(stateEnum);
75
-
76
- /**
77
- * Finds a state by its code
78
- *
79
- * @param {string} code the state code
80
- * @returns {State | undefined} the state or undefined
81
- * @example findStateByCode('CA') => { code: 'CA', name: 'California' }
82
- * @example findStateByCode('XX') => undefined
83
- */
84
- function findStateByCode(code: string): State | undefined {
85
- return validatedStates.find((state) => state.code === code.toUpperCase());
86
- }
87
-
88
- export { StatesSchema, findStateByCode, validatedStates };
89
- export type { State };
90
-
91
- export const canadaProvinces = [
92
- { name: 'Alberta', code: 'AB' },
93
- { name: 'British Columbia', code: 'BC' },
94
- { name: 'Manitoba', code: 'MB' },
95
- { name: 'New Brunswick', code: 'NB' },
96
- { name: 'Newfoundland and Labrador', code: 'NL' },
97
- { name: 'Nova Scotia', code: 'NS' },
98
- { name: 'Ontario', code: 'ON' },
99
- { name: 'Prince Edward Island', code: 'PE' },
100
- { name: 'Quebec', code: 'QC' },
101
- { name: 'Saskatchewan', code: 'SK' },
102
- { name: 'Northwest Territories', code: 'NT' },
103
- { name: 'Nunavut', code: 'NU' },
104
- { name: 'Yukon', code: 'YT' },
105
- ];
106
-
107
- const canadaProvinceEnum = canadaProvinces.reduce(
108
- (acc, province) => {
109
- acc[province.code] = province.code;
110
- return acc;
111
- },
112
- {} as Record<string, string>,
113
- );
114
-
115
- export const CanadaProvinceCode = Object.freeze(canadaProvinceEnum);
116
-
117
- export function refineAddressState(
118
- country: string | undefined | null,
119
- state: string | undefined | null,
120
- ) {
121
- {
122
- if (country === CountryCode['US'])
123
- return z.nativeEnum(StateCode).nullable().optional().safeParse(state)
124
- .success;
125
- if (country === CountryCode['CA'])
126
- return z
127
- .nativeEnum(CanadaProvinceCode)
128
- .nullable()
129
- .optional()
130
- .safeParse(state).success;
131
- return z.string().min(2).max(35).nullable().optional().safeParse(state)
132
- .success;
133
- }
134
- }
135
-
136
- export const CountryStateSchema = z
137
- .object({
138
- country: CountryEnumSchema.nullable().optional(),
139
- state: z.string().nullable().optional(),
140
- })
141
- .refine(({ state, country }) => refineAddressState(country, state), {
142
- message: `state value is not valid. It should be 2 uppercase letters representing the valid state for the country.`,
143
- });
144
-
145
- export const RequiredCountryStateSchema = z
146
- .object({
147
- country: CountryEnumSchema,
148
- state: z.string(),
149
- })
150
- .refine(
151
- ({ state, country }) => {
152
- if (country === CountryCode['US']) {
153
- return z.nativeEnum(StateCode).safeParse(state).success;
154
- }
155
- if (country === CountryCode['CA']) {
156
- return z.nativeEnum(CanadaProvinceCode).safeParse(state).success;
157
- }
158
- return z.string().min(2).max(35).safeParse(state).success;
159
- },
160
- {
161
- message: `state value is not valid. It should be 2 uppercase letters representing the valid state for the country.`,
162
- },
163
- );
@@ -1,35 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import { SignatureStatus } from './common.types';
4
- import { SignerDataSchema } from './signer.types';
5
-
6
- export const ISubDocPreview = IBaseEntity.extend({
7
- templateId: z.string().min(1).max(36),
8
- signers: z.array(SignerDataSchema).nullable(),
9
- documentId: z.string().min(1).max(36).nullable(),
10
- signatureUrl: z.string().min(1).max(255).nullable(),
11
- errors: z.string().nullable(),
12
- status: z.nativeEnum(SignatureStatus),
13
- jointStatus: z.nativeEnum(SignatureStatus),
14
- });
15
- export type ISubDocPreview = z.infer<typeof ISubDocPreview>;
16
-
17
- export const CreateSubDocPreview = z.object({
18
- templateId: z.string().min(1).max(36),
19
- subDocPreviewData: z.record(z.string()),
20
- });
21
- export type CreateSubDocPreview = z.infer<typeof CreateSubDocPreview>;
22
-
23
- export const CreateSubDocPreviewResponse = z.object({ documentId: z.string() });
24
- export type CreateSubDocPreviewResponse = z.infer<
25
- typeof CreateSubDocPreviewResponse
26
- >;
27
-
28
- export const SubDocPreviewFormFields = z.array(
29
- z.object({
30
- id: z.string().min(1).max(255),
31
- type: z.string().min(1).max(255),
32
- options: z.array(z.string()).optional(),
33
- }),
34
- );
35
- export type SubDocPreviewFormFields = z.infer<typeof SubDocPreviewFormFields>;