@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,68 +0,0 @@
1
- import { z } from 'zod';
2
- import { TypeID } from 'typeid-js';
3
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
4
- import { IBaseEntity } from './entity.types';
5
- import { IPaginationMeta } from './common.types';
6
- extendZodWithOpenApi(z);
7
-
8
- export const secureRequestIdSchema = z.string().refine(
9
- (value) => {
10
- try {
11
- const tid = TypeID.fromString(value);
12
- return tid.getType() === 'secure_request';
13
- } catch {
14
- return false;
15
- }
16
- },
17
- {
18
- message:
19
- 'Invalid Secure ID format. Must be a valid TypeID with "secure_request" prefix. Example: secure_request_01j5y5ghx8fvc83dmx3pznq7hv',
20
- },
21
- );
22
-
23
- export enum SecureRequestTemplate {
24
- DEFAULT = 'default',
25
- NORTHCAP = 'northcap',
26
- }
27
-
28
- export const SecureRequestZod = IBaseEntity.extend({
29
- payload: z.record(z.any()), // Accepts objects with any shape
30
- ipAddress: z.string().nullable(),
31
- template: z.string().nullable(),
32
- });
33
- export type SecureRequestZod = z.infer<typeof SecureRequestZod>;
34
-
35
- export const IPaginatedSecureRequests = z.object({
36
- items: z.array(SecureRequestZod),
37
- meta: IPaginationMeta,
38
- });
39
- export type IPaginatedSecureRequests = z.infer<typeof IPaginatedSecureRequests>;
40
-
41
- export const PostSecureRequestBody = z.object({
42
- payload: z.record(z.any()).refine(
43
- (payload) => {
44
- const stringified = JSON.stringify(payload);
45
- if (stringified.length > 1024 * 100) {
46
- throw new Error('Payload exceeds maximum size of 100KB');
47
- }
48
- return stringified;
49
- },
50
- {
51
- message:
52
- 'Payload values must be strings with a maximum length of 100 characters',
53
- },
54
- ),
55
- template: z
56
- .nativeEnum(SecureRequestTemplate)
57
- .nullable()
58
- .openapi({ description: 'Template name' }),
59
- });
60
- export type PostSecureRequestBody = z.infer<typeof PostSecureRequestBody>;
61
-
62
- export const PostSecureRequestResponse = SecureRequestZod.extend({
63
- exchangeApiKeyId: z.string().optional(),
64
- exchangeImportId: z.string().optional(),
65
- });
66
- export type PostSecureRequestResponse = z.infer<
67
- typeof PostSecureRequestResponse
68
- >;
@@ -1,651 +0,0 @@
1
- import { z } from 'zod';
2
- import {
3
- ComplianceReview,
4
- IPaginationMeta,
5
- PaginationOptionsZod,
6
- SenderIdentityStatus,
7
- TemplateStatus,
8
- TemplateType,
9
- } from './common.types';
10
- import { TypeID } from 'typeid-js';
11
-
12
- /**
13
- * Example error response:
14
- * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
15
- *
16
- * Example Success response:
17
- * https://developers.boldsign.com/documents/send-document-from-template/?region=us#example-response
18
- * https://developers.boldsign.com/documents/send-document/?region=us#example-response
19
- */
20
- export const BoldSignCreateDocumentResponseZod = z.object({
21
- errors: z.record(z.string(), z.array(z.string())),
22
- type: z.string(),
23
- title: z.string(),
24
- status: z.number().openapi({
25
- example: 400,
26
- }),
27
- traceId: z.string(),
28
- documentId: z.string(),
29
- });
30
- export type BoldSignCreateDocumentResponseZod = z.infer<
31
- typeof BoldSignCreateDocumentResponseZod
32
- >;
33
-
34
- /**
35
- * Example error response:
36
- * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
37
- *
38
- * Example Success response:
39
- * https://developers.boldsign.com/embedded-signing/get-embedded-signing-link/?region=us#example-response
40
- */
41
- export const BoldSignGetEmbeddedDocumentLinkResponseZod = z.object({
42
- errors: z.record(z.string(), z.array(z.string())),
43
- type: z.string(),
44
- title: z.string(),
45
- status: z.number().openapi({
46
- example: 400,
47
- }),
48
- traceId: z.string(),
49
- signLink: z.string(),
50
- });
51
- export type BoldSignGetEmbeddedDocumentLinkResponseZod = z.infer<
52
- typeof BoldSignGetEmbeddedDocumentLinkResponseZod
53
- >;
54
-
55
- /**
56
- * Example error response:
57
- * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
58
- *
59
- * Example Success response:
60
- * https://developers.boldsign.com/branding/create-brand/?region=us#example-response
61
- * https://developers.boldsign.com/branding/update-brand/?region=us#example-response
62
- */
63
- export const BoldSignUpsertBrandResponseZod = z.object({
64
- errors: z.record(z.string(), z.array(z.string())),
65
- type: z.string(),
66
- title: z.string(),
67
- status: z.number().openapi({
68
- example: 400,
69
- }),
70
- traceId: z.string(),
71
- brandId: z.string(),
72
- });
73
- export type BoldSignUpsertBrandResponseZod = z.infer<
74
- typeof BoldSignUpsertBrandResponseZod
75
- >;
76
-
77
- /**
78
- * Example error response:
79
- * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
80
- *
81
- * Example Success response:
82
- * https://developers.boldsign.com/branding/delete-brand/?region=us#example-response
83
- */
84
- export const BoldSignDeleteBrandResponseZod = z.object({
85
- errors: z.record(z.string(), z.array(z.string())),
86
- type: z.string(),
87
- title: z.string(),
88
- status: z.number().openapi({
89
- example: 400,
90
- }),
91
- traceId: z.string(),
92
- message: z.string(),
93
- });
94
- export type BoldSignDeleteBrandResponseZod = z.infer<
95
- typeof BoldSignDeleteBrandResponseZod
96
- >;
97
-
98
- export const SignerMessageResponseZod = z.object({
99
- message: z.string(),
100
- });
101
- export type SignerMessageResponseZod = z.infer<typeof SignerMessageResponseZod>;
102
-
103
- const BoundsSchema = z.object({
104
- x: z.number(),
105
- y: z.number(),
106
- width: z.number(),
107
- height: z.number(),
108
- });
109
-
110
- export const FormFieldSchema = z.object({
111
- id: z.string(),
112
- value: z.union([z.string(), z.number(), z.null()]).optional(),
113
- name: z.string().optional(),
114
- fieldType: z.string().optional(),
115
- pageNumber: z.number().optional(),
116
- bounds: BoundsSchema.optional(),
117
- isRequired: z.boolean().optional(),
118
- editableDateFieldSettings: z.record(z.string(), z.string()).optional(),
119
- validationType: z.string().optional(),
120
- });
121
-
122
- const BaseSignerSchema = z.object({
123
- signerType: z.literal('Signer'),
124
- signerRole: z.string(),
125
- });
126
-
127
- const TemplateSignerSchema = BaseSignerSchema.extend({
128
- roleIndex: z.number(),
129
- signerName: z.string(),
130
- signerEmail: z.string().optional(),
131
- signerOrder: z.number().optional(),
132
- existingFormFields: z.array(FormFieldSchema),
133
- });
134
-
135
- const NonTemplateSignerSchema = BaseSignerSchema.extend({
136
- name: z.string(),
137
- emailAddress: z.string().optional(),
138
- formFields: z.array(FormFieldSchema),
139
- });
140
-
141
- export const SignerDataSchema = z.union([
142
- TemplateSignerSchema,
143
- NonTemplateSignerSchema,
144
- ]);
145
-
146
- const TemplateDetailFormFieldSchema = z.object({
147
- id: z.string(),
148
- fieldType: z.string(),
149
- value: z.string(),
150
- font: z.string(),
151
- isRequired: z.boolean(),
152
- isReadOnly: z.boolean(),
153
- lineHeight: z.number(),
154
- fontSize: z.number(),
155
- fontHexColor: z.string(),
156
- isUnderLineFont: z.boolean(),
157
- isItalicFont: z.boolean(),
158
- isBoldFont: z.boolean(),
159
- groupName: z.string(),
160
- placeholder: z.string(),
161
- validationtype: z.string(),
162
- validationCustomRegex: z.string(),
163
- validationCustomRegexMessage: z.string().nullable(),
164
- dateFormat: z.string(),
165
- imageInfo: z.any().nullable(),
166
- attachmentInfo: z.any().nullable(),
167
- editableDateFieldSettings: z.any().nullable(),
168
- conditionalRules: z.array(z.any()),
169
- dropdownOptions: z.array(z.any()),
170
- bounds: BoundsSchema,
171
- pageNumber: z.number(),
172
- dataSyncTag: z.string(),
173
- textAlign: z.string(),
174
- textDirection: z.string(),
175
- });
176
-
177
- export type TemplateDetailFormFieldSchema = z.infer<
178
- typeof TemplateDetailFormFieldSchema
179
- >;
180
-
181
- const RecipientNotificationSettingsSchema = z.object({
182
- signatureRequest: z.boolean(),
183
- declined: z.boolean(),
184
- revoked: z.boolean(),
185
- signed: z.boolean(),
186
- completed: z.boolean(),
187
- expired: z.boolean(),
188
- reassigned: z.boolean(),
189
- deleted: z.boolean(),
190
- reminders: z.boolean(),
191
- editRecipient: z.boolean(),
192
- editDocument: z.boolean(),
193
- viewed: z.boolean().optional(), // only present in the outer object
194
- });
195
-
196
- const RoleSchema = z.object({
197
- name: z.string(),
198
- index: z.number(),
199
- defaultSignerName: z.string(),
200
- defaultSignerEmail: z.string(),
201
- phoneNumber: z.string().nullable(),
202
- signerOrder: z.number(),
203
- signerType: z.string(),
204
- hostEmail: z.string(),
205
- hostName: z.string(),
206
- language: z.number(),
207
- allowRoleEdit: z.boolean(),
208
- allowRoleDelete: z.boolean(),
209
- enableAccessCode: z.boolean(),
210
- enableEmailOTP: z.boolean(),
211
- imposeAuthentication: z.string(),
212
- deliveryMode: z.string(),
213
- allowFieldConfiguration: z.boolean(),
214
- formFields: z.array(TemplateDetailFormFieldSchema),
215
- enableEditRecipients: z.boolean(),
216
- enableDeleteRecipients: z.boolean(),
217
- locale: z.string(),
218
- recipientNotificationSettings: RecipientNotificationSettingsSchema,
219
- });
220
-
221
- export const TemplateRoleSchema = RoleSchema;
222
-
223
- const FileDetailSchema = z.object({
224
- documentName: z.string(),
225
- order: z.number(),
226
- pageCount: z.number(),
227
- });
228
-
229
- const CreatedBySchema = z.object({
230
- emailAddress: z.string(),
231
- name: z.string(),
232
- });
233
-
234
- const DocumentInfoSchema = z.object({
235
- language: z.number(),
236
- title: z.string(),
237
- description: z.string(),
238
- locale: z.string(),
239
- });
240
-
241
- export const TemplateDataSchema = z.object({
242
- templateId: z.string(),
243
- title: z.string(),
244
- description: z.string(),
245
- documentTitle: z.string(),
246
- documentMessage: z.string(),
247
- files: z.array(FileDetailSchema),
248
- roles: z.array(RoleSchema),
249
- commonFields: z.array(z.any()),
250
- cCDetails: z.array(z.any()),
251
- brandId: z.string(),
252
- allowMessageEditing: z.boolean(),
253
- allowNewRoles: z.boolean(),
254
- enableReassign: z.boolean(),
255
- EnablePrintAndSign: z.boolean(),
256
- enableSigningOrder: z.boolean(),
257
- createdDate: z.number(),
258
- createdBy: CreatedBySchema,
259
- sharedTemplateDetail: z.array(z.any()),
260
- documentInfo: z.array(DocumentInfoSchema),
261
- labels: z.array(z.string()),
262
- templateLabels: z.array(z.string()),
263
- recipientNotificationSettings: RecipientNotificationSettingsSchema,
264
- });
265
-
266
- export type FormField = z.infer<typeof FormFieldSchema>;
267
- export type SignerData = z.infer<typeof SignerDataSchema>;
268
- export type TemplateDetailFormField = z.infer<
269
- typeof TemplateDetailFormFieldSchema
270
- >;
271
- export type TemplateRole = z.infer<typeof TemplateRoleSchema>;
272
- export type TemplateData = z.infer<typeof TemplateDataSchema>;
273
-
274
- const DocumentFormFieldSchema = z.object({
275
- id: z.string(),
276
- type: z.string(),
277
- value: z.string(),
278
- font: z.string(),
279
- isRequired: z.boolean(),
280
- isReadOnly: z.boolean(),
281
- lineHeight: z.number(),
282
- fontSize: z.number(),
283
- fontColor: z.string(),
284
- isUnderline: z.boolean(),
285
- isItalic: z.boolean(),
286
- isBold: z.boolean(),
287
- groupName: z.string(),
288
- placeholder: z.string(),
289
- validationtype: z.string(),
290
- validationCustomRegex: z.string(),
291
- validationCustomRegexMessage: z.string(),
292
- dateFormat: z.string(),
293
- imageInfo: z.null(),
294
- attachmentInfo: z.null(),
295
- fileInfo: z.null(),
296
- editableDateFieldSettings: z.null(),
297
- conditionalLogic: z.array(z.any()),
298
- hyperlinkText: z.string(),
299
- dropdownOptions: z.array(z.any()),
300
- bounds: BoundsSchema,
301
- pageNumber: z.number(),
302
- dataSyncTag: z.string(),
303
- textAlign: z.string(),
304
- textDirection: z.string(),
305
- characterSpacing: z.number(),
306
- });
307
-
308
- const IdVerificationSchema = z.object({
309
- type: z.string(),
310
- maximumRetryCount: z.number(),
311
- status: z.string(),
312
- nameMatcher: z.string(),
313
- requireLiveCapture: z.boolean(),
314
- requireMatchingSelfie: z.boolean(),
315
- holdForPrefill: z.boolean(),
316
- prefillCompleted: z.boolean(),
317
- });
318
-
319
- const SignerDetailSchema = z.object({
320
- signerName: z.string(),
321
- signerRole: z.string(),
322
- signerEmail: z.string(),
323
- status: z.string(),
324
- enableAccessCode: z.boolean(),
325
- isAuthenticationFailed: z.boolean().nullable(),
326
- enableEmailOTP: z.boolean(),
327
- authenticationType: z.string(),
328
- isDeliveryFailed: z.boolean(),
329
- isViewed: z.boolean(),
330
- order: z.number(),
331
- signerType: z.string(),
332
- hostEmail: z.string(),
333
- hostName: z.string(),
334
- isReassigned: z.boolean(),
335
- privateMessage: z.string(),
336
- allowFieldConfiguration: z.boolean(),
337
- idVerification: IdVerificationSchema,
338
- formFields: z.array(DocumentFormFieldSchema),
339
- language: z.number(),
340
- locale: z.string(),
341
- recipientNotificationSettings: RecipientNotificationSettingsSchema,
342
- authenticationRetryCount: z.number().nullable(),
343
- });
344
-
345
- const SenderDetailSchema = z.object({
346
- name: z.string(),
347
- privateMessage: z.null(),
348
- emailAddress: z.string(),
349
- isViewed: z.boolean(),
350
- });
351
-
352
- const FileSchema = z.object({
353
- documentName: z.string(),
354
- order: z.number(),
355
- pageCount: z.number(),
356
- });
357
-
358
- const ReminderSettingsSchema = z.object({
359
- enableAutoReminder: z.boolean(),
360
- reminderDays: z.number(),
361
- reminderCount: z.number(),
362
- });
363
-
364
- const DocumentHistorySchema = z.object({
365
- id: z.string(),
366
- name: z.string(),
367
- email: z.string(),
368
- toName: z.string(),
369
- toEmail: z.string(),
370
- ipaddress: z.string(),
371
- action: z.string(),
372
- timestamp: z.number(),
373
- });
374
-
375
- const DocumentSchema = z.object({
376
- documentId: z.string(),
377
- brandId: z.string(),
378
- messageTitle: z.string(),
379
- documentDescription: z.string(),
380
- status: z.string(),
381
- files: z.array(FileSchema),
382
- senderDetail: SenderDetailSchema,
383
- signerDetails: z.array(SignerDetailSchema),
384
- behalfOf: z.null(),
385
- ccDetails: z.array(z.any()),
386
- reminderSettings: ReminderSettingsSchema,
387
- reassign: z.array(z.any()),
388
- documentHistory: z.array(DocumentHistorySchema),
389
- activityBy: z.string(),
390
- activityDate: z.number(),
391
- activityAction: z.string(),
392
- createdDate: z.number(),
393
- expiryDays: z.number(),
394
- expiryDate: z.null(),
395
- enableSigningOrder: z.boolean(),
396
- isDeleted: z.boolean(),
397
- revokeMessage: z.string(),
398
- declineMessage: z.string(),
399
- applicationId: z.string(),
400
- labels: z.array(z.any()),
401
- disableEmails: z.boolean(),
402
- disableExpiryAlert: z.boolean(),
403
- hideDocumentId: z.boolean(),
404
- enablePrintAndSign: z.boolean(),
405
- enableReassign: z.boolean(),
406
- recipientNotificationSettings: RecipientNotificationSettingsSchema,
407
- scheduledSendTime: z.number(),
408
- });
409
-
410
- export type DocumentSchema = z.infer<typeof DocumentSchema>;
411
-
412
- export const TemplateZod = z.object({
413
- documentId: z.string(),
414
- templateName: z.string(),
415
- });
416
- export type TemplateZod = z.infer<typeof TemplateZod>;
417
-
418
- export const PageDetailZod = z.object({
419
- totalRecordsCount: z.number(),
420
- pageSize: z.number(),
421
- totalPages: z.number(),
422
- page: z.number(),
423
- });
424
- export type PageDetail = z.infer<typeof PageDetailZod>;
425
-
426
- export const TemplatesPaginatedZod = z.object({
427
- items: z.array(TemplateZod),
428
- meta: IPaginationMeta,
429
- });
430
- export type TemplatesPaginatedZod = z.infer<typeof TemplatesPaginatedZod>;
431
- export type SignerDetailSchema = z.infer<typeof SignerDetailSchema>;
432
-
433
- export const SignerTemplateSchema = z.object({
434
- id: z.string(),
435
- tid: z.string().max(255),
436
- name: z.string().max(255).nullable(),
437
- type: z.nativeEnum(TemplateType),
438
- status: z.nativeEnum(TemplateStatus),
439
- complianceStatus: z.nativeEnum(ComplianceReview),
440
- log: z.string().nullable(),
441
- });
442
-
443
- export type SignerTemplateZod = z.infer<typeof SignerTemplateSchema>;
444
-
445
- export const SignerTemplatesPaginatedZod = z.object({
446
- items: z.array(SignerTemplateSchema),
447
- meta: IPaginationMeta,
448
- });
449
- export type SignerTemplatesPaginatedZod = z.infer<
450
- typeof SignerTemplatesPaginatedZod
451
- >;
452
-
453
- export const SignerBrandSchema = z.object({
454
- id: z.string(),
455
- tid: z.string(),
456
- brandName: z.string().nullable(),
457
- brandLogoId: z.string().nullable(),
458
- backgroundColor: z.string().nullable(),
459
- buttonColor: z.string().nullable(),
460
- buttonTextColor: z.string().nullable(),
461
- complianceStatus: z.nativeEnum(ComplianceReview),
462
- });
463
- export type SignerBrandZod = z.infer<typeof SignerBrandSchema>;
464
-
465
- export const SignerBrandsPaginatedZod = z.object({
466
- items: z.array(SignerBrandSchema),
467
- meta: IPaginationMeta,
468
- });
469
- export type SignerBrandsPaginatedZod = z.infer<typeof SignerBrandsPaginatedZod>;
470
-
471
- export const SignerSenderIdentitySchema = z.object({
472
- id: z.string(),
473
- name: z.string().nullable(),
474
- email: z.string().nullable(),
475
- status: z.nativeEnum(SenderIdentityStatus),
476
- complianceStatus: z.nativeEnum(ComplianceReview),
477
- });
478
- export type SignerSenderIdentityZod = z.infer<
479
- typeof SignerSenderIdentitySchema
480
- >;
481
-
482
- export const SignerSenderIdentitiesPaginatedZod = z.object({
483
- items: z.array(SignerSenderIdentitySchema),
484
- meta: IPaginationMeta,
485
- });
486
- export type SignerSenderIdentitiesPaginatedZod = z.infer<
487
- typeof SignerSenderIdentitiesPaginatedZod
488
- >;
489
-
490
- export const ValidatedTemplateResponse = z.object({
491
- templateId: z.string().min(1).max(36),
492
- errorMessage: z.string().min(1).max(255).optional(),
493
- requiredVariables: z.record(z.string(), z.string()).optional(),
494
- additionalVariables: z.record(z.string(), z.string()).optional(),
495
- configCheck: z.string().min(1).max(5),
496
- });
497
- export type ValidatedTemplateResponse = z.infer<
498
- typeof ValidatedTemplateResponse
499
- >;
500
-
501
- export const ValidatedTemplatesResponse = z.array(ValidatedTemplateResponse);
502
- export type ValidatedTemplatesResponse = z.infer<
503
- typeof ValidatedTemplatesResponse
504
- >;
505
-
506
- export const TemplatePathParams = z.object({
507
- templateId: z.string().min(1).max(36),
508
- });
509
- export type TemplatePathParams = z.infer<typeof TemplatePathParams>;
510
-
511
- export const brandIdSchema = z.string().refine(
512
- (value) => {
513
- try {
514
- const tid = TypeID.fromString(value);
515
- return tid.getType() === 'signer_brand';
516
- } catch {
517
- return false;
518
- }
519
- },
520
- {
521
- message:
522
- 'Invalid brand ID format. Must be a valid TypeID with "signer_brand" prefix. ex: signer_brand_00041061050r3gg28a1c60t3gf',
523
- },
524
- );
525
-
526
- export const BrandPathParams = z.object({
527
- id: brandIdSchema,
528
- });
529
- export type BrandPathParams = z.infer<typeof BrandPathParams>;
530
-
531
- export const senderIdentityIdSchema = z.string().refine(
532
- (value) => {
533
- try {
534
- const tid = TypeID.fromString(value);
535
- return tid.getType() === 'signer_sender_identity';
536
- } catch {
537
- return false;
538
- }
539
- },
540
- {
541
- message:
542
- 'Invalid sender identity ID format. Must be a valid TypeID with "signer_sender_identity" prefix. ex: signer_sender_identity_00041061050r3gg28a1c60t3gf',
543
- },
544
- );
545
-
546
- export const SenderIdentityPathParams = z.object({
547
- id: senderIdentityIdSchema,
548
- });
549
- export type SenderIdentityPathParams = z.infer<typeof SenderIdentityPathParams>;
550
-
551
- const BrandSchema = z.object({
552
- brandId: z.string().uuid(),
553
- brandLogo: z.string(),
554
- brandName: z.string(),
555
- backgroundColor: z.string(),
556
- buttonColor: z.string(),
557
- buttonTextColor: z.string(),
558
- emailDisplayName: z.string(),
559
- disclaimerTitle: z.string(),
560
- disclaimerDescription: z.string(),
561
- redirectUrl: z.string().url(),
562
- isDefault: z.boolean(),
563
- canHideTagLine: z.boolean(),
564
- combineAuditTrail: z.boolean(),
565
- emailSignedDocument: z.string(),
566
- documentTimeZone: z.string(),
567
- showBuiltInFormFields: z.boolean(),
568
- allowCustomFieldCreation: z.boolean(),
569
- showSharedCustomFields: z.boolean(),
570
- hideDecline: z.boolean(),
571
- hideSave: z.boolean(),
572
- excludeAuditTrailFromEmail: z.boolean(),
573
-
574
- documentExpirySettings: z.object({
575
- expiryDateType: z.string(),
576
- expiryValue: z.number(),
577
- enableDefaultExpiryAlert: z.boolean(),
578
- enableAutoReminder: z.boolean(),
579
- reminderDays: z.number(),
580
- reminderCount: z.number(),
581
- }),
582
-
583
- customDomainSettings: z.object({
584
- domainName: z.string(),
585
- fromName: z.string(),
586
- }),
587
-
588
- isDomainVerified: z.boolean(),
589
- });
590
- export type BrandSchema = z.infer<typeof BrandSchema>;
591
-
592
- export const UpdateSignerTemplateZod = z.object({
593
- complianceStatus: z.nativeEnum(ComplianceReview).optional(),
594
- });
595
- export type UpdateSignerTemplateZod = z.infer<typeof UpdateSignerTemplateZod>;
596
-
597
- export const CreateSignerBrandZod = z.object({
598
- brandName: z.string().min(1).max(255),
599
- emailDisplayName: z.string().min(1).max(255),
600
- backgroundColor: z.string().min(1).max(7),
601
- buttonColor: z.string().min(1).max(7),
602
- buttonTextColor: z.string().min(1).max(7),
603
- accountId: z.string().min(1),
604
- });
605
- export type CreateSignerBrandZod = z.infer<typeof CreateSignerBrandZod>;
606
-
607
- export const UpdateSignerBrandZod = z.object({
608
- brandName: z.string().min(1).max(255).optional(),
609
- brandLogoId: z.string().min(1).optional(),
610
- emailDisplayName: z.string().min(1).max(255).optional(),
611
- backgroundColor: z.string().min(1).max(7).optional(),
612
- buttonColor: z.string().min(1).max(7).optional(),
613
- buttonTextColor: z.string().min(1).max(7).optional(),
614
- complianceStatus: z.nativeEnum(ComplianceReview).optional(),
615
- });
616
- export type UpdateSignerBrandZod = z.infer<typeof UpdateSignerBrandZod>;
617
-
618
- export const CreateSignerSenderIdentityZod = z.object({
619
- name: z.string().min(1).max(255),
620
- email: z.string().email().openapi({ example: 'test@test.com' }),
621
- });
622
- export type CreateSignerSenderIdentityZod = z.infer<
623
- typeof CreateSignerSenderIdentityZod
624
- >;
625
-
626
- export const UpdateSignerSenderIdentityZod = z.object({
627
- name: z.string().min(1).max(255).optional(),
628
- email: z.string().email().openapi({ example: 'test@test.com' }).optional(),
629
- complianceStatus: z.nativeEnum(ComplianceReview).optional(),
630
- status: z.nativeEnum(SenderIdentityStatus).optional(),
631
- });
632
- export type UpdateSignerSenderIdentityZod = z.infer<
633
- typeof UpdateSignerSenderIdentityZod
634
- >;
635
-
636
- export const DocumentRecipientChangeBody = z.object({
637
- newSignerName: z.string().min(1).max(255),
638
- reason: z.string().min(1).max(255),
639
- newSignerEmail: z.string().min(1).max(255),
640
- oldSignerEmail: z.string().min(1).max(255),
641
- order: z.number().optional(), // optional if not always provided
642
- });
643
- export type DocumentRecipientChangeBody = z.infer<
644
- typeof DocumentRecipientChangeBody
645
- >;
646
-
647
- export const SignerPaginationQuery = PaginationOptionsZod.merge(
648
- z.object({
649
- status: z.nativeEnum(ComplianceReview).optional(),
650
- }),
651
- );