@dalmore/api-contracts 0.0.0-dev.d6badc9 → 0.0.0-dev.e325dbb

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 (187) hide show
  1. package/README.md +23 -19
  2. package/common/types/account-contact.types.ts +2 -1
  3. package/common/types/account-manager.types.ts +3 -7
  4. package/common/types/auth.types.ts +7 -18
  5. package/common/types/common.types.ts +22 -0
  6. package/common/types/contact-us.types.ts +6 -2
  7. package/common/types/covered-person.types.ts +2 -1
  8. package/common/types/escrow-account.types.ts +3 -3
  9. package/common/types/individuals.types.ts +3 -2
  10. package/common/types/investor-account.types.ts +2 -1
  11. package/common/types/invite.types.ts +27 -1
  12. package/common/types/legal-entity.types.ts +3 -2
  13. package/common/types/mail-template.types.ts +34 -0
  14. package/common/types/note.types.ts +1 -1
  15. package/common/types/site-settings.types.ts +2 -1
  16. package/common/types/trade.types.ts +47 -1
  17. package/common/types/trusted-contact.types.ts +7 -7
  18. package/common/types/user.types.ts +2 -5
  19. package/index.ts +10 -0
  20. package/package.json +23 -32
  21. package/contracts/compliance/account-contacts/index.ts +0 -82
  22. package/contracts/compliance/account-managers/index.ts +0 -142
  23. package/contracts/compliance/account-settings/index.ts +0 -59
  24. package/contracts/compliance/accounts/index.ts +0 -187
  25. package/contracts/compliance/activities/index.ts +0 -55
  26. package/contracts/compliance/aic/index.ts +0 -60
  27. package/contracts/compliance/api-keys/index.ts +0 -91
  28. package/contracts/compliance/assets/index.ts +0 -122
  29. package/contracts/compliance/auth/index.ts +0 -134
  30. package/contracts/compliance/batch-jobs/index.ts +0 -62
  31. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  32. package/contracts/compliance/checklist/index.ts +0 -87
  33. package/contracts/compliance/checklist-items/index.ts +0 -86
  34. package/contracts/compliance/covered-persons/index.ts +0 -97
  35. package/contracts/compliance/dashboard/index.ts +0 -111
  36. package/contracts/compliance/data-records/index.ts +0 -116
  37. package/contracts/compliance/data-rooms/index.ts +0 -113
  38. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  39. package/contracts/compliance/disbursement/index.ts +0 -165
  40. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  41. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  42. package/contracts/compliance/domain-filters/index.ts +0 -117
  43. package/contracts/compliance/email-themes/index.ts +0 -284
  44. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  45. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  46. package/contracts/compliance/exchange-imports/index.ts +0 -137
  47. package/contracts/compliance/files/index.ts +0 -267
  48. package/contracts/compliance/files-public/index.ts +0 -188
  49. package/contracts/compliance/health/index.ts +0 -26
  50. package/contracts/compliance/index.ts +0 -151
  51. package/contracts/compliance/individuals/index.ts +0 -57
  52. package/contracts/compliance/investor-accounts/index.ts +0 -141
  53. package/contracts/compliance/invites/index.ts +0 -137
  54. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  55. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  56. package/contracts/compliance/issuers/index.ts +0 -97
  57. package/contracts/compliance/job-items/index.ts +0 -58
  58. package/contracts/compliance/jobs/index.ts +0 -59
  59. package/contracts/compliance/kyb/index.ts +0 -54
  60. package/contracts/compliance/kyc/index.ts +0 -77
  61. package/contracts/compliance/legal-entities/index.ts +0 -57
  62. package/contracts/compliance/login-histories/index.ts +0 -37
  63. package/contracts/compliance/notes/index.ts +0 -69
  64. package/contracts/compliance/notification-channels/index.ts +0 -251
  65. package/contracts/compliance/notion-databases/index.ts +0 -107
  66. package/contracts/compliance/notion-pages/index.ts +0 -105
  67. package/contracts/compliance/offering-reports/index.ts +0 -149
  68. package/contracts/compliance/offerings/index.ts +0 -233
  69. package/contracts/compliance/pages/index.ts +0 -178
  70. package/contracts/compliance/payment-methods/index.ts +0 -57
  71. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  72. package/contracts/compliance/review/index.ts +0 -169
  73. package/contracts/compliance/roles/index.ts +0 -34
  74. package/contracts/compliance/secondary-customers/index.ts +0 -77
  75. package/contracts/compliance/secondary-orders/index.ts +0 -60
  76. package/contracts/compliance/secondary-trades/index.ts +0 -100
  77. package/contracts/compliance/secure-requests/index.ts +0 -54
  78. package/contracts/compliance/signer/index.ts +0 -369
  79. package/contracts/compliance/site-links/index.ts +0 -128
  80. package/contracts/compliance/site-settings/index.ts +0 -669
  81. package/contracts/compliance/sites/index.ts +0 -56
  82. package/contracts/compliance/state-machine/index.ts +0 -94
  83. package/contracts/compliance/tasks/index.ts +0 -91
  84. package/contracts/compliance/third-parties/index.ts +0 -52
  85. package/contracts/compliance/trade-line-items/index.ts +0 -59
  86. package/contracts/compliance/trades/index.ts +0 -230
  87. package/contracts/compliance/transactions/index.ts +0 -161
  88. package/contracts/compliance/user-manuals/index.ts +0 -271
  89. package/contracts/compliance/user-settings/index.ts +0 -189
  90. package/contracts/compliance/users/index.ts +0 -221
  91. package/contracts/compliance/webhooks/index.ts +0 -41
  92. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  93. package/contracts/compliance-apikey/index.ts +0 -14
  94. package/contracts/index.ts +0 -6
  95. package/contracts/investors/account-contacts/index.ts +0 -58
  96. package/contracts/investors/aic/index.ts +0 -59
  97. package/contracts/investors/assets/index.ts +0 -61
  98. package/contracts/investors/auth/index.ts +0 -116
  99. package/contracts/investors/bonus-tiers/index.ts +0 -55
  100. package/contracts/investors/cart/index.ts +0 -75
  101. package/contracts/investors/contact-us/index.ts +0 -48
  102. package/contracts/investors/data-records/index.ts +0 -113
  103. package/contracts/investors/data-rooms/index.ts +0 -96
  104. package/contracts/investors/files/index.ts +0 -167
  105. package/contracts/investors/files-public/index.ts +0 -185
  106. package/contracts/investors/index.ts +0 -72
  107. package/contracts/investors/individuals/index.ts +0 -121
  108. package/contracts/investors/investor-accounts/index.ts +0 -110
  109. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  110. package/contracts/investors/issuers/index.ts +0 -30
  111. package/contracts/investors/legal-entities/index.ts +0 -93
  112. package/contracts/investors/notes/index.ts +0 -69
  113. package/contracts/investors/offerings/index.ts +0 -93
  114. package/contracts/investors/pages/index.ts +0 -88
  115. package/contracts/investors/payment-methods/index.ts +0 -149
  116. package/contracts/investors/portfolios/index.ts +0 -53
  117. package/contracts/investors/sites/index.ts +0 -96
  118. package/contracts/investors/tasks/index.ts +0 -111
  119. package/contracts/investors/trade-line-items/index.ts +0 -75
  120. package/contracts/investors/trades/index.ts +0 -114
  121. package/contracts/investors/transactions/index.ts +0 -37
  122. package/contracts/investors/trusted-contacts/index.ts +0 -93
  123. package/contracts/investors/user-manuals/index.ts +0 -62
  124. package/contracts/investors/user-settings/index.ts +0 -170
  125. package/contracts/investors/users/index.ts +0 -45
  126. package/contracts/investors/webhooks/index.ts +0 -30
  127. package/contracts/issuers/account-contacts/index.ts +0 -76
  128. package/contracts/issuers/account-integrations/index.ts +0 -97
  129. package/contracts/issuers/account-settings/index.ts +0 -36
  130. package/contracts/issuers/accounts/index.ts +0 -97
  131. package/contracts/issuers/activities/index.ts +0 -54
  132. package/contracts/issuers/aic/index.ts +0 -39
  133. package/contracts/issuers/api-key-logs/index.ts +0 -53
  134. package/contracts/issuers/api-keys/index.ts +0 -93
  135. package/contracts/issuers/assets/index.ts +0 -122
  136. package/contracts/issuers/auth/index.ts +0 -152
  137. package/contracts/issuers/bonus-tiers/index.ts +0 -73
  138. package/contracts/issuers/contact-us/index.ts +0 -48
  139. package/contracts/issuers/covered-persons/index.ts +0 -136
  140. package/contracts/issuers/dashboard/index.ts +0 -72
  141. package/contracts/issuers/data-records/index.ts +0 -257
  142. package/contracts/issuers/data-rooms/index.ts +0 -134
  143. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  144. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  145. package/contracts/issuers/disbursements/index.ts +0 -189
  146. package/contracts/issuers/email-themes/index.ts +0 -242
  147. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  148. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  149. package/contracts/issuers/files/index.ts +0 -166
  150. package/contracts/issuers/files-public/index.ts +0 -166
  151. package/contracts/issuers/health/index.ts +0 -24
  152. package/contracts/issuers/index.ts +0 -116
  153. package/contracts/issuers/investor-accounts/index.ts +0 -148
  154. package/contracts/issuers/invites/index.ts +0 -129
  155. package/contracts/issuers/issuer/index.ts +0 -94
  156. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  157. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  158. package/contracts/issuers/kyc/index.ts +0 -38
  159. package/contracts/issuers/login-histories/index.ts +0 -51
  160. package/contracts/issuers/notes/index.ts +0 -69
  161. package/contracts/issuers/notification-channels/index.ts +0 -251
  162. package/contracts/issuers/offerings/index.ts +0 -206
  163. package/contracts/issuers/pages/index.ts +0 -138
  164. package/contracts/issuers/payment-methods/index.ts +0 -61
  165. package/contracts/issuers/portfolios/index.ts +0 -36
  166. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  167. package/contracts/issuers/review/index.ts +0 -63
  168. package/contracts/issuers/secondary-customers/index.ts +0 -55
  169. package/contracts/issuers/secondary-orders/index.ts +0 -57
  170. package/contracts/issuers/secondary-trades/index.ts +0 -57
  171. package/contracts/issuers/secure-requests/index.ts +0 -34
  172. package/contracts/issuers/site-links/index.ts +0 -116
  173. package/contracts/issuers/site-settings/index.ts +0 -585
  174. package/contracts/issuers/sites/index.ts +0 -32
  175. package/contracts/issuers/tasks/index.ts +0 -111
  176. package/contracts/issuers/trades/index.ts +0 -132
  177. package/contracts/issuers/transactions/index.ts +0 -158
  178. package/contracts/issuers/user-manuals/index.ts +0 -62
  179. package/contracts/issuers/user-settings/index.ts +0 -170
  180. package/contracts/issuers/users/index.ts +0 -126
  181. package/contracts/secondaries/accounts/index.ts +0 -58
  182. package/contracts/secondaries/index.ts +0 -23
  183. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  184. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  185. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  186. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  187. package/contracts/secondaries/secondary-trades/index.ts +0 -56
package/README.md CHANGED
@@ -14,32 +14,33 @@ npm install @dalmore/api-contracts@dev
14
14
 
15
15
  ## Usage
16
16
 
17
- ### Import specific contracts (recommended for tree-shaking)
17
+ ### Import from main entry
18
18
 
19
19
  ```typescript
20
- import { complianceContract } from '@dalmore/api-contracts/compliance';
21
- import { investorsContract } from '@dalmore/api-contracts/investors';
22
- import { issuersContract } from '@dalmore/api-contracts/issuers';
23
- import { clientsContract } from '@dalmore/api-contracts/clients';
20
+ import { clientsContract } from '@dalmore/api-contracts';
21
+ import type { IInvestorAccount } from '@dalmore/api-contracts';
24
22
  ```
25
23
 
26
- ### Import types
24
+ ### Import specific subpaths (recommended for tree-shaking)
27
25
 
28
26
  ```typescript
29
- import type { IInvestorAccount } from '@dalmore/api-contracts/types/investor-account.types';
30
- import type { ITrade } from '@dalmore/api-contracts/types/trade.types';
27
+ // Import clients contract
28
+ import { clientsContract } from '@dalmore/api-contracts/clients';
29
+
30
+ // Import types
31
+ import type { IInvestorAccount, ITrade } from '@dalmore/api-contracts/types';
31
32
  ```
32
33
 
33
34
  ### Create a typed client
34
35
 
35
36
  ```typescript
36
- import { complianceContract } from '@dalmore/api-contracts/compliance';
37
+ import { clientsContract } from '@dalmore/api-contracts/clients';
37
38
  import { initClient } from '@ts-rest/core';
38
39
 
39
- const client = initClient(complianceContract, {
40
+ const client = initClient(clientsContract, {
40
41
  baseUrl: 'https://platform.dalmoregroup.com',
41
42
  baseHeaders: {
42
- Authorization: `Bearer ${token}`,
43
+ 'X-API-Key': `${apiKey}`,
43
44
  },
44
45
  });
45
46
 
@@ -53,17 +54,20 @@ const { status, body } = await client.accounts.getAccounts({
53
54
 
54
55
  This package requires the following peer dependencies:
55
56
 
56
- - `@ts-rest/core` ^3.0.0
57
- - `zod` ^3.0.0
57
+ - `@anatine/zod-openapi` ^1.14.2
58
+ - `@ts-rest/core` ^3.52.1
59
+ - `typeid-js` ^1.2.0
60
+ - `zod` ^3.24.4
58
61
 
59
- ## Available Contracts
62
+ ## Available Exports
60
63
 
61
- - `complianceContract` - Compliance portal API
62
- - `investorsContract` - Investor portal API
63
- - `issuersContract` - Issuer portal API
64
64
  - `clientsContract` - Client API (API key auth)
65
- - `secondariesContract` - Secondaries API
66
- - `complianceApiKeyContract` - Compliance API (API key auth)
65
+
66
+ ## Available Subpath Exports
67
+
68
+ - `@dalmore/api-contracts` - Main entry (clients contract and types)
69
+ - `@dalmore/api-contracts/clients` - Clients contract
70
+ - `@dalmore/api-contracts/types` - All common types
67
71
 
68
72
  ## TypeScript Configuration
69
73
 
@@ -6,6 +6,7 @@ import { PhoneZodSchema } from './phone.type';
6
6
  import {
7
7
  AccountContactType,
8
8
  AccountZod,
9
+ EmailSchema,
9
10
  IPaginationMeta,
10
11
  } from './common.types';
11
12
  import { IBaseEntity } from './entity.types';
@@ -60,7 +61,7 @@ export const PatchAccountContactZod = z.object({
60
61
  .openapi({ example: 'Mr' }),
61
62
  firstName: z.string().min(1).max(150).openapi({ example: 'John' }),
62
63
  lastName: z.string().min(1).max(150).openapi({ example: 'Doe' }),
63
- email: z.string().email().openapi({ example: 'john.doe@example.com' }),
64
+ email: EmailSchema.openapi({ example: 'john.doe@example.com' }),
64
65
  phone: PhoneZodSchema.nullable()
65
66
  .optional()
66
67
  .openapi({ example: '+12124567890' }),
@@ -4,7 +4,7 @@ import { TypeID } from 'typeid-js';
4
4
  import { IBaseEntity } from './entity.types';
5
5
  import { PhoneNumberData } from './sms.types';
6
6
  import { userIdSchema, UserZod } from './user.types';
7
- import { IPaginationMeta } from './common.types';
7
+ import { EmailSchema, IPaginationMeta } from './common.types';
8
8
  import { PhoneZodSchema } from './phone.type';
9
9
 
10
10
  extendZodWithOpenApi(z);
@@ -68,7 +68,7 @@ export type IAccountManagerZod = z.infer<typeof IAccountManagerZod>;
68
68
  export const PostAccountManagerZod = z.object({
69
69
  firstName: z.string().min(1).max(255).openapi({ example: 'John' }),
70
70
  lastName: z.string().min(1).max(255).openapi({ example: 'Doe' }),
71
- email: z.string().email().openapi({ example: 'john.doe@example.com' }),
71
+ email: EmailSchema,
72
72
  phone: PhoneZodSchema.nullable()
73
73
  .optional()
74
74
  .openapi({ example: '+12124567890' }),
@@ -80,11 +80,7 @@ export type PostAccountManagerZod = z.infer<typeof PostAccountManagerZod>;
80
80
  export const PatchAccountManagerZod = z.object({
81
81
  firstName: z.string().min(1).max(255).optional().openapi({ example: 'John' }),
82
82
  lastName: z.string().min(1).max(255).optional().openapi({ example: 'Doe' }),
83
- email: z
84
- .string()
85
- .email()
86
- .optional()
87
- .openapi({ example: 'john.doe@example.com' }),
83
+ email: EmailSchema.optional(),
88
84
  phone: PhoneZodSchema.nullable()
89
85
  .optional()
90
86
  .openapi({ example: '+12124567890' }),
@@ -8,6 +8,7 @@ import {
8
8
  ManagedByType,
9
9
  UserRole,
10
10
  createUrlSchema,
11
+ EmailSchema,
11
12
  } from './common.types';
12
13
  import { TypeID } from 'typeid-js';
13
14
  import { TwoFactorMethod } from './sms.types';
@@ -60,13 +61,7 @@ const BaseAuthBody = z.object({
60
61
  .openapi({
61
62
  example: 'Armstrong',
62
63
  }),
63
- email: z
64
- .string()
65
- .email()
66
- .transform((val) => val.toLowerCase())
67
- .openapi({
68
- example: 'neil@dalmoregroup.com',
69
- }),
64
+ email: EmailSchema,
70
65
  password: PasswordSchema,
71
66
  });
72
67
 
@@ -99,13 +94,7 @@ export const IChangePasswordBodyZod = z
99
94
  });
100
95
 
101
96
  export const LoginBody = z.object({
102
- email: z
103
- .string()
104
- .email()
105
- .transform((val) => val.toLowerCase())
106
- .openapi({
107
- example: 'neil@dalmoregroup.com',
108
- }),
97
+ email: EmailSchema,
109
98
  password: z.string().openapi({
110
99
  example: 'Secretpassword6#',
111
100
  }),
@@ -297,7 +286,7 @@ export const RegisterBodyInvestors = BaseAuthBody.extend({
297
286
  });
298
287
 
299
288
  export const ResetPasswordVerifyBody = z.object({
300
- email: z.string().email(),
289
+ email: EmailSchema,
301
290
  code: z.string().length(6, 'code is not 6 characters').openapi({
302
291
  example: '123456',
303
292
  }),
@@ -315,7 +304,7 @@ export type ResetPasswordVerifyResponseType = z.infer<
315
304
  >;
316
305
 
317
306
  export const ResetPasswordBody = z.object({
318
- email: z.string().email(),
307
+ email: EmailSchema,
319
308
  code: z.string().length(6, 'code is not 6 characters').openapi({
320
309
  example: '123456',
321
310
  }),
@@ -337,7 +326,7 @@ export type ClientAuthSuccessResponse = z.infer<
337
326
  >;
338
327
 
339
328
  export const AdminForgotPasswordRequestZod = z.object({
340
- email: z.string().email(),
329
+ email: EmailSchema,
341
330
  portal: z.nativeEnum(PortalType),
342
331
  });
343
332
  export type AdminForgotPasswordRequestZod = z.infer<
@@ -345,7 +334,7 @@ export type AdminForgotPasswordRequestZod = z.infer<
345
334
  >;
346
335
 
347
336
  export const InvestorForgotPasswordRequestZod = z.object({
348
- email: z.string().email(),
337
+ email: EmailSchema,
349
338
  url: createUrlSchema({ strict: true }),
350
339
  });
351
340
  export type InvestorForgotPasswordRequestZod = z.infer<
@@ -69,6 +69,10 @@ export enum BaseStatus {
69
69
  VOIDED = 'VOIDED',
70
70
  JOIN = 'JOIN',
71
71
  RESTORE = 'RESTORE',
72
+ ACTIVE = 'ACTIVE',
73
+ LOCKED = 'LOCKED',
74
+ ENABLED = 'ENABLED',
75
+ DISABLED = 'DISABLED',
72
76
  }
73
77
 
74
78
  export const UserWithoutPasswordAccountZod = IBaseEntity.extend({
@@ -808,6 +812,8 @@ export enum EventField {
808
812
  SA_STATUS = 'saStatus',
809
813
  ONBOARDING_STATUS = 'onboardingStatus',
810
814
  TRANSACTION_STATUS = 'transactionStatus',
815
+ ACTIVE = 'active',
816
+ LOCKED = 'locked',
811
817
  }
812
818
 
813
819
  export enum EventName {
@@ -1528,3 +1534,19 @@ export const StringToBooleanSchema = z.preprocess(
1528
1534
  z.boolean(),
1529
1535
  );
1530
1536
  export type StringToBooleanSchema = z.infer<typeof StringToBooleanSchema>;
1537
+
1538
+ /**
1539
+ * Reusable email schema that validates email format, transforms to lowercase,
1540
+ * and includes OpenAPI metadata.
1541
+ *
1542
+ * @example
1543
+ * EmailSchema.parse('John.Doe@EXAMPLE.COM'); // returns 'john.doe@example.com'
1544
+ * EmailSchema.optional().parse(undefined); // returns undefined
1545
+ */
1546
+ export const EmailSchema = z
1547
+ .string()
1548
+ .email()
1549
+ .transform((val) => val.toLowerCase())
1550
+ .openapi({
1551
+ example: 'neil@dalmoregroup.com',
1552
+ });
@@ -1,7 +1,11 @@
1
1
  import { z } from 'zod';
2
2
  import { extendZodWithOpenApi } from '@anatine/zod-openapi';
3
3
  import { TypeID } from 'typeid-js';
4
- import { BaseContactUsOptions, createUrlSchema } from './common.types';
4
+ import {
5
+ BaseContactUsOptions,
6
+ createUrlSchema,
7
+ EmailSchema,
8
+ } from './common.types';
5
9
  extendZodWithOpenApi(z);
6
10
 
7
11
  export const contactUsIdSchema = z.string().refine(
@@ -55,7 +59,7 @@ export const InvestorPostContactUsZod = PostContactUsZod.extend({
55
59
  export type InvestorPostContactUsZod = z.infer<typeof InvestorPostContactUsZod>;
56
60
 
57
61
  export const PublicInvestorContactUsZod = PostContactUsZod.extend({
58
- email: z.string().email().openapi({ example: 'email@example.com' }),
62
+ email: EmailSchema,
59
63
  firstName: z.string().min(1).max(100).openapi({ example: 'John' }),
60
64
  lastName: z.string().min(1).max(100).openapi({ example: 'Doe' }),
61
65
  contactOption: z.nativeEnum(InvestorContactOptions).openapi({
@@ -6,6 +6,7 @@ import {
6
6
  ComplianceReview,
7
7
  CoveredPersonsRoleType,
8
8
  CoveredPersonsStatus,
9
+ EmailSchema,
9
10
  IDType,
10
11
  IPaginationMeta,
11
12
  } from './common.types';
@@ -137,7 +138,7 @@ export const PatchCoveredPersonsZod = z
137
138
  .openapi({ example: CoveredPersonsRoleType.ACCOUNTING }),
138
139
 
139
140
  ownership: z.number().min(0).max(100).openapi({ example: 15 }).optional(),
140
- email: z.string().nullable().optional(),
141
+ email: EmailSchema.nullable().optional(),
141
142
  idType: z
142
143
  .nativeEnum(IDType)
143
144
  .optional()
@@ -1,6 +1,6 @@
1
1
  import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
2
  import { z } from 'zod';
3
- import { AccountZod, IPaginationMeta } from './common.types';
3
+ import { AccountZod, EmailSchema, IPaginationMeta } from './common.types';
4
4
  import { IBaseEntity } from './entity.types';
5
5
  import { TypeID } from 'typeid-js';
6
6
  import { accountIdSchema } from './account.types';
@@ -43,7 +43,7 @@ export const PostEscrowAccount = z.object({
43
43
  accountNumber: z.string().optional().nullable(),
44
44
  routingNumber: z.string().min(9).max(9).optional().nullable(),
45
45
  agentName: z.string().min(2).max(50),
46
- agentEmail: z.string().email(),
46
+ agentEmail: EmailSchema,
47
47
  });
48
48
 
49
49
  export type PostEscrowAccount = z.infer<typeof PostEscrowAccount>;
@@ -65,7 +65,7 @@ export const PatchEscrowAccount = z.object({
65
65
  accountNumber: z.string().min(10).max(18).optional().nullable().optional(),
66
66
  routingNumber: z.string().min(9).max(9).optional().nullable().optional(),
67
67
  agentName: z.string().min(2).max(50).optional(),
68
- agentEmail: z.string().email().optional(),
68
+ agentEmail: EmailSchema.optional(),
69
69
  });
70
70
 
71
71
  export type PatchEscrowAccount = z.infer<typeof PatchEscrowAccount>;
@@ -16,6 +16,7 @@ import {
16
16
  EmploymentStatus,
17
17
  SourceOfIncome,
18
18
  AMLProvider,
19
+ EmailSchema,
19
20
  } from './common.types';
20
21
  import { IBaseEntity } from './entity.types';
21
22
  import { IInvestorAccount } from './investor-account.types';
@@ -288,7 +289,7 @@ export const PostIndividualBodySchema = z
288
289
  .string()
289
290
  .length(3, 'currencyCode must be 3 digits')
290
291
  .optional(),
291
- email: z.string().email().optional(),
292
+ email: EmailSchema.optional(),
292
293
  role: z.nativeEnum(IndividualRole),
293
294
  phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
294
295
  ownership: z.coerce
@@ -387,7 +388,7 @@ export const UpdateIndividualBodySchema = z
387
388
  .length(3, 'currencyCode must be 3 digits')
388
389
  .optional(),
389
390
  phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
390
- email: z.string().email().optional(),
391
+ email: EmailSchema.optional(),
391
392
  ownership: z.coerce
392
393
  .number()
393
394
  .min(0, 'Ownership is less than 0')
@@ -24,6 +24,7 @@ import {
24
24
  SortBy,
25
25
  SortOrder,
26
26
  AMLProvider,
27
+ EmailSchema,
27
28
  } from './common.types';
28
29
  import { accountIdSchema } from './account.types';
29
30
  import { SaStatus, tradeIdSchema, TradeZod } from './trade.types';
@@ -131,7 +132,7 @@ export type PostClientInvestorAccountBody = z.infer<
131
132
 
132
133
  export const UpdateInvestorAccountBodySchema = z.object({
133
134
  name: z.string().optional(),
134
- email: z.string().email().optional(),
135
+ email: EmailSchema.optional(),
135
136
  });
136
137
  export type UpdateInvestorAccountBody = z.infer<
137
138
  typeof UpdateInvestorAccountBodySchema
@@ -3,7 +3,9 @@ import {
3
3
  AccountZod,
4
4
  IPaginationMeta,
5
5
  IssuerRole,
6
+ PortalType,
6
7
  UserRole,
8
+ EmailSchema,
7
9
  } from './common.types';
8
10
  import { extendZodWithOpenApi } from '@anatine/zod-openapi';
9
11
  import { TypeID } from 'typeid-js';
@@ -48,7 +50,7 @@ export const InviteWithUrl = InviteWithoutSecretZod.extend({
48
50
  export type InviteWithUrl = z.infer<typeof InviteWithUrl>;
49
51
 
50
52
  export const PostIssuerInviteZod = z.object({
51
- email: z.string().email(),
53
+ email: EmailSchema,
52
54
  role: z.nativeEnum(IssuerRole),
53
55
  });
54
56
 
@@ -131,3 +133,27 @@ export const PatchInviteForComplianceZod = PatchInviteRoleZod.extend({
131
133
  export type PatchInviteForComplianceZod = z.infer<
132
134
  typeof PatchInviteForComplianceZod
133
135
  >;
136
+
137
+ export const PostInviteZod = z.object({
138
+ email: EmailSchema,
139
+ role: z.nativeEnum(UserRole).openapi({
140
+ example: UserRole.ADMIN,
141
+ }),
142
+ accountId: z.string().optional().openapi({
143
+ example: 'account_01j5y5ghx5fg68d663j1fvy2x7',
144
+ }),
145
+ portalType: z.nativeEnum(PortalType).optional().openapi({
146
+ example: PortalType.ISSUER,
147
+ }),
148
+ });
149
+
150
+ export type PostInviteZod = z.infer<typeof PostInviteZod>;
151
+
152
+ export const CompliancePostInviteZod = z.object({
153
+ email: EmailSchema,
154
+ role: z.nativeEnum(UserRole).openapi({
155
+ example: UserRole.ADMIN,
156
+ }),
157
+ });
158
+
159
+ export type CompliancePostInviteZod = z.infer<typeof CompliancePostInviteZod>;
@@ -2,6 +2,7 @@ import { z } from 'zod';
2
2
  import { IBaseEntity } from './entity.types';
3
3
  import {
4
4
  dateSchema,
5
+ EmailSchema,
5
6
  IPaginationMeta,
6
7
  KYBStatus,
7
8
  SanctionsStatus,
@@ -138,7 +139,7 @@ export const PostLegalEntitySchema = z
138
139
  investorAccountId: investorAccountIdSchema,
139
140
  name: CompanyNameSchema,
140
141
  ein: EINSchema,
141
- email: z.string().email().optional(),
142
+ email: EmailSchema.optional(),
142
143
  companyType: CompanyTypeSchema.optional(),
143
144
  phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
144
145
  dateOfIncorporation: z.lazy(() => dateSchema).optional(),
@@ -153,7 +154,7 @@ export const UpdateLegalEntitySchema = z
153
154
  id: legalEntityIdSchema.optional(),
154
155
  name: CompanyNameSchema.optional(),
155
156
  ein: EINSchema,
156
- email: z.string().email().optional(),
157
+ email: EmailSchema.optional(),
157
158
  companyType: CompanyTypeSchema.optional(),
158
159
  phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
159
160
  dateOfIncorporation: z.lazy(() => dateSchema).optional(),
@@ -434,3 +434,37 @@ export type EmailThemeSetting = z.infer<typeof EmailThemeSettingZod>;
434
434
 
435
435
  export const EmailThemeSettingsZod = z.array(EmailThemeSettingZod);
436
436
  export type EmailThemeSettingsZod = z.infer<typeof EmailThemeSettingsZod>;
437
+
438
+ /**
439
+ * Response from a successful email send operation.
440
+ * Based on SendGrid SDK's ClientResponse structure.
441
+ */
442
+ export const EmailSendResponseSchema = z.object({
443
+ /** HTTP status code from SendGrid (e.g., 202 for accepted) */
444
+ statusCode: z.number(),
445
+ /** SendGrid's x-message-id header for tracking emails in their dashboard */
446
+ messageId: z.string().optional(),
447
+ /** Full response headers, available for debugging if needed */
448
+ headers: z.record(z.string(), z.unknown()).optional(),
449
+ });
450
+ export type EmailSendResponse = z.infer<typeof EmailSendResponseSchema>;
451
+
452
+ /**
453
+ * Error from a failed email send operation.
454
+ * Fields are optional because error shapes vary depending on failure type
455
+ * (network errors vs SendGrid API errors).
456
+ */
457
+ export const EmailSendErrorSchema = z.object({
458
+ /** Human-readable error message */
459
+ message: z.string(),
460
+ /** Network-level error code (e.g., 'ECONNREFUSED', 'ETIMEDOUT') */
461
+ code: z.string().optional(),
462
+ /** HTTP status code if request reached SendGrid (e.g., 400, 401, 403, 413, 500) */
463
+ statusCode: z.number().optional(),
464
+ /**
465
+ * SendGrid's error response body. Structure: { errors: [{ message, field, help, id }] }
466
+ * @see https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send#responses
467
+ */
468
+ response: z.unknown().optional(),
469
+ });
470
+ export type EmailSendError = z.infer<typeof EmailSendErrorSchema>;
@@ -79,7 +79,7 @@ export const PostNoteBody = z.object({
79
79
  export type PostNoteBody = z.infer<typeof PostNoteBody>;
80
80
 
81
81
  export const CompliancePostNoteBody = PostNoteBody.extend({
82
- accountId: accountIdSchema,
82
+ accountId: accountIdSchema.nullable().default(null),
83
83
  });
84
84
 
85
85
  export type CompliancePostNoteBody = z.infer<typeof CompliancePostNoteBody>;
@@ -3,6 +3,7 @@ import { z } from 'zod';
3
3
  import { fileIdSchema } from './file.types';
4
4
  import {
5
5
  AccountZod,
6
+ EmailSchema,
6
7
  HexCodeColorSchema,
7
8
  IPaginationMeta,
8
9
  SubdomainSchema,
@@ -462,7 +463,7 @@ export const GetSenderEmailZod = z.object({
462
463
  export type GetSenderEmailZod = z.infer<typeof GetSenderEmailZod>;
463
464
 
464
465
  export const PatchSenderEmailZod = z.object({
465
- senderEmail: z.string().email().openapi({ example: 'example@example.com' }),
466
+ senderEmail: EmailSchema,
466
467
  });
467
468
  export type PatchSenderEmailZod = z.infer<typeof PatchSenderEmailZod>;
468
469
 
@@ -22,12 +22,13 @@ import {
22
22
  AccountStatus,
23
23
  SavedQuery,
24
24
  } from './common.types';
25
- import { offeringIdSchema } from './offering.types';
25
+ import { IOffering, offeringIdSchema } from './offering.types';
26
26
  import { IBaseEntity } from './entity.types';
27
27
  import { extendZodWithOpenApi } from '@anatine/zod-openapi';
28
28
  import { TypeID } from 'typeid-js';
29
29
  import {
30
30
  paymentMethodIdSchema,
31
+ PaymentMethodResponse,
31
32
  PaymentMethodType,
32
33
  } from './payment-methods.types';
33
34
  import {
@@ -35,6 +36,7 @@ import {
35
36
  InvestorAccountExportFilters,
36
37
  ComplianceInvestorAccountExportFilters,
37
38
  RegisteredInvestorUserRawZod,
39
+ IInvestorAccount,
38
40
  } from './investor-account.types';
39
41
  import {
40
42
  tradeLineItemIdSchema,
@@ -132,6 +134,7 @@ export const CheckResultsSchema = z.object({
132
134
  export type CheckResults = z.infer<typeof CheckResultsSchema>;
133
135
 
134
136
  export const TradeIdPrefix = 'trade';
137
+ export const TradeSnapshotIdPrefix = 'trade_snapshot';
135
138
 
136
139
  export const tradeIdSchema = z.string().refine(
137
140
  (value) => {
@@ -170,6 +173,21 @@ export const tradeIdOrTidSchema = z.union([
170
173
  .openapi({ example: 'tid_00041061050r3gg28a1c60t3gf' }),
171
174
  ]);
172
175
 
176
+ export const tradeSnapshotIdSchema = z.string().refine(
177
+ (value) => {
178
+ try {
179
+ const tid = TypeID.fromString(value);
180
+ return tid.getType() === TradeSnapshotIdPrefix;
181
+ } catch {
182
+ return false;
183
+ }
184
+ },
185
+ {
186
+ message:
187
+ 'Invalid trade snapshot ID format. Must be a valid TypeID with "trade_snapshot" prefix. ex: trade_snapshot_00041061050r3gg28a1c60t3gf',
188
+ },
189
+ );
190
+
173
191
  export enum SaStatus {
174
192
  PENDING = BaseStatus.PENDING,
175
193
  SIGNED = BaseStatus.SIGNED,
@@ -274,9 +292,21 @@ export type TradeBalanceResultZod = z.infer<typeof TradeBalanceResultZod>;
274
292
 
275
293
  export const TradeZod = IBaseEntity.extend({
276
294
  investorAccountId: z.lazy(() => investorAccountIdSchema.nullable()),
295
+ investorAccount: z
296
+ .lazy(() => IInvestorAccount)
297
+ .optional()
298
+ .nullable(),
299
+ offering: z
300
+ .lazy(() => IOffering)
301
+ .optional()
302
+ .nullable(),
277
303
  accountId: accountIdSchema.nullable(),
278
304
  offeringId: z.lazy(() => offeringIdSchema.nullable()),
279
305
  paymentMethodId: z.lazy(() => paymentMethodIdSchema).nullable(),
306
+ paymentMethod: z
307
+ .lazy(() => PaymentMethodResponse)
308
+ .optional()
309
+ .nullable(),
280
310
  userId: z.lazy(() => userIdSchema.nullable()),
281
311
  tradeNumber: z.string(),
282
312
  ip: z.string().nullable(),
@@ -342,6 +372,21 @@ export const TradeZod = IBaseEntity.extend({
342
372
  });
343
373
  export type TradeZod = z.infer<typeof TradeZod>;
344
374
 
375
+ export enum SnapshotEvent {
376
+ COMPLIANCE_APPROVED = 'COMPLIANCE_APPROVED',
377
+ COMPLIANCE_REJECTED = 'COMPLIANCE_REJECTED',
378
+ CANCELLED = 'CANCELLED',
379
+ PLACED = 'PLACED',
380
+ SETTLED = 'SETTLED',
381
+ }
382
+
383
+ export const GetTradeSnapshotEventsResponse = z.object({
384
+ events: z.array(z.nativeEnum(SnapshotEvent)),
385
+ });
386
+ export type GetTradeSnapshotEventsResponse = z.infer<
387
+ typeof GetTradeSnapshotEventsResponse
388
+ >;
389
+
345
390
  export const IPaginatedTrade = z.object({
346
391
  items: z.array(TradeZod),
347
392
  meta: IPaginationMeta,
@@ -424,6 +469,7 @@ export const TradeFiltersZod = z.object({
424
469
  .openapi({
425
470
  example: 'issuer_01jfw4q6qef30s6fpqtsxw94ya',
426
471
  }),
472
+ snapshotEvent: z.nativeEnum(SnapshotEvent).optional(),
427
473
  offeringType: z.nativeEnum(OfferingType).optional(),
428
474
  managedBy: z.nativeEnum(ManagedByType).optional(),
429
475
  platform: z.nativeEnum(Platforms).optional(),
@@ -2,7 +2,11 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
2
  import { TypeID } from 'typeid-js';
3
3
  import { z } from 'zod';
4
4
  import { IBaseEntity } from './entity.types';
5
- import { IPaginationMeta, TrustedContactRelationship } from './common.types';
5
+ import {
6
+ EmailSchema,
7
+ IPaginationMeta,
8
+ TrustedContactRelationship,
9
+ } from './common.types';
6
10
  import { PhoneZodSchema } from './phone.type';
7
11
  import { AddressSchema } from './address.types';
8
12
  import { investorAccountIdSchema } from './investor-account.types';
@@ -68,7 +72,7 @@ export const PostTrustedContactZod = z
68
72
  .object({
69
73
  firstName: z.string().min(1).max(255).openapi({ example: 'John' }),
70
74
  lastName: z.string().min(1).max(255).openapi({ example: 'Doe' }),
71
- email: z.string().email().openapi({ example: 'john.doe@example.com' }),
75
+ email: EmailSchema.openapi({ example: 'john.doe@example.com' }),
72
76
  phone: PhoneZodSchema.nullable().optional(),
73
77
  relationship: z
74
78
  .nativeEnum(TrustedContactRelationship)
@@ -92,11 +96,7 @@ export const PatchTrustedContactZod = z
92
96
  .optional()
93
97
  .openapi({ example: 'John' }),
94
98
  lastName: z.string().min(1).max(255).optional().openapi({ example: 'Doe' }),
95
- email: z
96
- .string()
97
- .email()
98
- .optional()
99
- .openapi({ example: 'john.doe@example.com' }),
99
+ email: EmailSchema.optional(),
100
100
  phone: PhoneZodSchema.nullable().optional(),
101
101
  relationship: z.nativeEnum(TrustedContactRelationship).optional().openapi({
102
102
  example: TrustedContactRelationship.CHILD,
@@ -11,6 +11,7 @@ import {
11
11
  StringToBooleanSchema,
12
12
  UserRole,
13
13
  UserType,
14
+ EmailSchema,
14
15
  } from './common.types';
15
16
  import { dateOrString, IBaseEntity } from './entity.types';
16
17
  import { PhoneZodSchema } from './phone.type';
@@ -147,11 +148,7 @@ export const UserMeUpdateZod = z.object({
147
148
  firstName: z.string().optional(),
148
149
  lastName: z.string().optional(),
149
150
  password: z.string().min(6).optional(),
150
- email: z
151
- .string()
152
- .email()
153
- .transform((val) => val.toLowerCase())
154
- .optional(),
151
+ email: EmailSchema.optional(),
155
152
  });
156
153
 
157
154
  export const UserZod = IBaseEntity.extend({
package/index.ts ADDED
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @dalmore/api-contracts
3
+ * Main entry point - re-exports clients contract and types
4
+ */
5
+
6
+ // Re-export clients contract
7
+ export * from './contracts/clients/index.js';
8
+
9
+ // Re-export all common types
10
+ export * from './common/types/index.js';