@dalmore/api-contracts 1.0.3 → 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 (303) hide show
  1. package/README.md +34 -60
  2. package/index.d.mts +17 -0
  3. package/index.d.ts +17 -0
  4. package/index.mjs +1001 -18638
  5. package/package.json +7 -54
  6. package/clients/index.mjs +0 -10970
  7. package/compliance/index.mjs +0 -20016
  8. package/compliance-apikey/index.mjs +0 -9795
  9. package/helpers/index.mjs +0 -146
  10. package/investors/index.mjs +0 -12844
  11. package/issuers/index.mjs +0 -16168
  12. package/secondaries/index.mjs +0 -10282
  13. package/src/common/helpers/index.ts +0 -205
  14. package/src/common/types/account-contact.types.ts +0 -98
  15. package/src/common/types/account-detail.types.ts +0 -27
  16. package/src/common/types/account-integration.types.ts +0 -143
  17. package/src/common/types/account-manager.types.ts +0 -124
  18. package/src/common/types/account.types.ts +0 -296
  19. package/src/common/types/activity.types.ts +0 -274
  20. package/src/common/types/address.types.ts +0 -41
  21. package/src/common/types/aic.types.ts +0 -246
  22. package/src/common/types/aml.types.ts +0 -18
  23. package/src/common/types/api-key-logs.types.ts +0 -66
  24. package/src/common/types/api-keys.types.ts +0 -69
  25. package/src/common/types/asset.types.ts +0 -338
  26. package/src/common/types/auth.types.ts +0 -370
  27. package/src/common/types/batch-jobs.types.ts +0 -150
  28. package/src/common/types/bonus-tier.types.ts +0 -147
  29. package/src/common/types/cart.types.ts +0 -18
  30. package/src/common/types/checklist-items.types.ts +0 -70
  31. package/src/common/types/checklist.types.ts +0 -97
  32. package/src/common/types/common.types.ts +0 -1520
  33. package/src/common/types/comply-advantage-api.types.ts +0 -316
  34. package/src/common/types/comply-advantage.types.ts +0 -25
  35. package/src/common/types/contact-us.types.ts +0 -107
  36. package/src/common/types/contract-helpers.ts +0 -205
  37. package/src/common/types/countries.types.ts +0 -375
  38. package/src/common/types/covered-person.types.ts +0 -274
  39. package/src/common/types/dashboard.types.ts +0 -799
  40. package/src/common/types/data-record.types.ts +0 -325
  41. package/src/common/types/data-room.types.ts +0 -242
  42. package/src/common/types/default-theme-config.types.ts +0 -87
  43. package/src/common/types/disbursement-adjustment.types.ts +0 -32
  44. package/src/common/types/disbursement-approval-user.types.ts +0 -100
  45. package/src/common/types/disbursement-review.types.ts +0 -110
  46. package/src/common/types/disbursement-transaction.types.ts +0 -72
  47. package/src/common/types/disbursements.types.ts +0 -310
  48. package/src/common/types/domain-filter.types.ts +0 -55
  49. package/src/common/types/email-theme.types.ts +0 -442
  50. package/src/common/types/entity.types.ts +0 -15
  51. package/src/common/types/error-responses.types.ts +0 -135
  52. package/src/common/types/escrow-account.types.ts +0 -104
  53. package/src/common/types/exchange-api-key.types.ts +0 -121
  54. package/src/common/types/exchange-import.types.ts +0 -36
  55. package/src/common/types/exchange-provider.types.ts +0 -329
  56. package/src/common/types/file.types.ts +0 -461
  57. package/src/common/types/health.types.ts +0 -29
  58. package/src/common/types/index.ts +0 -48
  59. package/src/common/types/individuals.types.ts +0 -554
  60. package/src/common/types/investor-account.types.ts +0 -1239
  61. package/src/common/types/investorAccountIdSchema.type.ts +0 -0
  62. package/src/common/types/investors-offering.types.ts +0 -65
  63. package/src/common/types/invite.types.ts +0 -133
  64. package/src/common/types/issuer-bank-account.types.ts +0 -107
  65. package/src/common/types/issuer-offering.types.ts +0 -306
  66. package/src/common/types/issuer-payment-method.types.ts +0 -341
  67. package/src/common/types/issuer.types.ts +0 -312
  68. package/src/common/types/job-item.types.ts +0 -119
  69. package/src/common/types/jobs.types.ts +0 -171
  70. package/src/common/types/kyb.types.ts +0 -53
  71. package/src/common/types/kyc.types.ts +0 -188
  72. package/src/common/types/legal-entity.types.ts +0 -185
  73. package/src/common/types/login-history.types.ts +0 -46
  74. package/src/common/types/mail-template.types.ts +0 -436
  75. package/src/common/types/north-cap-integration.types.ts +0 -190
  76. package/src/common/types/note.types.ts +0 -109
  77. package/src/common/types/notification.types.ts +0 -58
  78. package/src/common/types/notion-api.types.ts +0 -374
  79. package/src/common/types/notion-database.types.ts +0 -125
  80. package/src/common/types/notion-page.types.ts +0 -267
  81. package/src/common/types/offering-reports.types.ts +0 -153
  82. package/src/common/types/offering-submission.types.ts +0 -314
  83. package/src/common/types/offering.types.ts +0 -590
  84. package/src/common/types/page-revision.types.ts +0 -86
  85. package/src/common/types/page.types.ts +0 -436
  86. package/src/common/types/password.type.ts +0 -15
  87. package/src/common/types/payment-methods.types.ts +0 -298
  88. package/src/common/types/phone.type.ts +0 -27
  89. package/src/common/types/portfolio.types.ts +0 -50
  90. package/src/common/types/privacy-policy-and-tos.types.ts +0 -231
  91. package/src/common/types/queue.types.ts +0 -111
  92. package/src/common/types/registered-reps.types.ts +0 -25
  93. package/src/common/types/rejection-reasons.types.ts +0 -56
  94. package/src/common/types/review.types.ts +0 -133
  95. package/src/common/types/role.types.ts +0 -26
  96. package/src/common/types/secondary-customer.types.ts +0 -66
  97. package/src/common/types/secondary-issuer.types.ts +0 -50
  98. package/src/common/types/secondary-order.types.ts +0 -58
  99. package/src/common/types/secondary-security.types.ts +0 -60
  100. package/src/common/types/secondary-trade.entity.ts +0 -16
  101. package/src/common/types/secondary-trade.types.ts +0 -95
  102. package/src/common/types/secure-request.types.ts +0 -68
  103. package/src/common/types/signer.types.ts +0 -651
  104. package/src/common/types/site-link.types.ts +0 -166
  105. package/src/common/types/site-settings.types.ts +0 -726
  106. package/src/common/types/site.types.ts +0 -270
  107. package/src/common/types/sms.types.ts +0 -30
  108. package/src/common/types/state-machine.types.ts +0 -177
  109. package/src/common/types/states.types.ts +0 -163
  110. package/src/common/types/subdoc-preview.types.ts +0 -35
  111. package/src/common/types/task.types.ts +0 -258
  112. package/src/common/types/trade-adjustment.type.ts +0 -33
  113. package/src/common/types/trade-line-item.type.ts +0 -132
  114. package/src/common/types/trade.types.ts +0 -931
  115. package/src/common/types/transaction.types.ts +0 -198
  116. package/src/common/types/trusted-contact.types.ts +0 -122
  117. package/src/common/types/typography.types.ts +0 -75
  118. package/src/common/types/user-manual.types.ts +0 -290
  119. package/src/common/types/user-setting.types.ts +0 -133
  120. package/src/common/types/user.types.ts +0 -320
  121. package/src/common/types/webhook.types.ts +0 -588
  122. package/src/common/types/zip.type.ts +0 -36
  123. package/src/contracts/clients/accounts/index.ts +0 -61
  124. package/src/contracts/clients/aic/index.ts +0 -59
  125. package/src/contracts/clients/api-key-logs/index.ts +0 -53
  126. package/src/contracts/clients/api-keys/index.ts +0 -73
  127. package/src/contracts/clients/assets/index.ts +0 -102
  128. package/src/contracts/clients/auth/index.ts +0 -50
  129. package/src/contracts/clients/files/index.ts +0 -166
  130. package/src/contracts/clients/files-public/index.ts +0 -166
  131. package/src/contracts/clients/index.ts +0 -44
  132. package/src/contracts/clients/individuals/index.ts +0 -93
  133. package/src/contracts/clients/investor-accounts/index.ts +0 -93
  134. package/src/contracts/clients/issuers/index.ts +0 -94
  135. package/src/contracts/clients/legal-entities/index.ts +0 -93
  136. package/src/contracts/clients/offerings/index.ts +0 -117
  137. package/src/contracts/clients/secure-requests/index.ts +0 -34
  138. package/src/contracts/clients/sites/index.ts +0 -56
  139. package/src/contracts/clients/trades/index.ts +0 -122
  140. package/src/contracts/compliance/account-contacts/index.ts +0 -82
  141. package/src/contracts/compliance/account-managers/index.ts +0 -142
  142. package/src/contracts/compliance/accounts/index.ts +0 -187
  143. package/src/contracts/compliance/activities/index.ts +0 -55
  144. package/src/contracts/compliance/aic/index.ts +0 -60
  145. package/src/contracts/compliance/api-keys/index.ts +0 -91
  146. package/src/contracts/compliance/assets/index.ts +0 -122
  147. package/src/contracts/compliance/auth/index.ts +0 -134
  148. package/src/contracts/compliance/batch-jobs/index.ts +0 -62
  149. package/src/contracts/compliance/bonus-tiers/index.ts +0 -55
  150. package/src/contracts/compliance/checklist/index.ts +0 -87
  151. package/src/contracts/compliance/checklist-items/index.ts +0 -86
  152. package/src/contracts/compliance/covered-persons/index.ts +0 -97
  153. package/src/contracts/compliance/dashboard/index.ts +0 -111
  154. package/src/contracts/compliance/data-records/index.ts +0 -116
  155. package/src/contracts/compliance/data-rooms/index.ts +0 -113
  156. package/src/contracts/compliance/default-theme-configs/index.ts +0 -95
  157. package/src/contracts/compliance/disbursement/index.ts +0 -165
  158. package/src/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  159. package/src/contracts/compliance/disbursement-transactions/index.ts +0 -37
  160. package/src/contracts/compliance/domain-filters/index.ts +0 -117
  161. package/src/contracts/compliance/email-themes/index.ts +0 -284
  162. package/src/contracts/compliance/escrow-accounts/index.ts +0 -85
  163. package/src/contracts/compliance/exchange-api-keys/index.ts +0 -129
  164. package/src/contracts/compliance/exchange-imports/index.ts +0 -137
  165. package/src/contracts/compliance/files/index.ts +0 -267
  166. package/src/contracts/compliance/files-public/index.ts +0 -188
  167. package/src/contracts/compliance/health/index.ts +0 -26
  168. package/src/contracts/compliance/index.ts +0 -147
  169. package/src/contracts/compliance/individuals/index.ts +0 -57
  170. package/src/contracts/compliance/investor-accounts/index.ts +0 -141
  171. package/src/contracts/compliance/invites/index.ts +0 -137
  172. package/src/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  173. package/src/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  174. package/src/contracts/compliance/issuers/index.ts +0 -97
  175. package/src/contracts/compliance/job-items/index.ts +0 -58
  176. package/src/contracts/compliance/jobs/index.ts +0 -59
  177. package/src/contracts/compliance/kyb/index.ts +0 -54
  178. package/src/contracts/compliance/kyc/index.ts +0 -77
  179. package/src/contracts/compliance/legal-entities/index.ts +0 -57
  180. package/src/contracts/compliance/login-histories/index.ts +0 -37
  181. package/src/contracts/compliance/notes/index.ts +0 -69
  182. package/src/contracts/compliance/notion-databases/index.ts +0 -107
  183. package/src/contracts/compliance/notion-pages/index.ts +0 -105
  184. package/src/contracts/compliance/offering-reports/index.ts +0 -149
  185. package/src/contracts/compliance/offerings/index.ts +0 -233
  186. package/src/contracts/compliance/pages/index.ts +0 -178
  187. package/src/contracts/compliance/payment-methods/index.ts +0 -57
  188. package/src/contracts/compliance/rejection-reasons/index.ts +0 -32
  189. package/src/contracts/compliance/review/index.ts +0 -169
  190. package/src/contracts/compliance/roles/index.ts +0 -34
  191. package/src/contracts/compliance/secondary-customers/index.ts +0 -77
  192. package/src/contracts/compliance/secondary-orders/index.ts +0 -60
  193. package/src/contracts/compliance/secondary-trades/index.ts +0 -100
  194. package/src/contracts/compliance/secure-requests/index.ts +0 -54
  195. package/src/contracts/compliance/signer/index.ts +0 -369
  196. package/src/contracts/compliance/site-links/index.ts +0 -128
  197. package/src/contracts/compliance/site-settings/index.ts +0 -669
  198. package/src/contracts/compliance/sites/index.ts +0 -56
  199. package/src/contracts/compliance/state-machine/index.ts +0 -94
  200. package/src/contracts/compliance/tasks/index.ts +0 -91
  201. package/src/contracts/compliance/third-parties/index.ts +0 -52
  202. package/src/contracts/compliance/trade-line-items/index.ts +0 -59
  203. package/src/contracts/compliance/trades/index.ts +0 -230
  204. package/src/contracts/compliance/transactions/index.ts +0 -161
  205. package/src/contracts/compliance/user-manuals/index.ts +0 -271
  206. package/src/contracts/compliance/user-settings/index.ts +0 -189
  207. package/src/contracts/compliance/users/index.ts +0 -200
  208. package/src/contracts/compliance/webhooks/index.ts +0 -41
  209. package/src/contracts/compliance-apikey/accounts/index.ts +0 -58
  210. package/src/contracts/compliance-apikey/index.ts +0 -14
  211. package/src/contracts/index.ts +0 -6
  212. package/src/contracts/investors/account-contacts/index.ts +0 -58
  213. package/src/contracts/investors/aic/index.ts +0 -59
  214. package/src/contracts/investors/assets/index.ts +0 -61
  215. package/src/contracts/investors/auth/index.ts +0 -116
  216. package/src/contracts/investors/bonus-tiers/index.ts +0 -37
  217. package/src/contracts/investors/cart/index.ts +0 -75
  218. package/src/contracts/investors/contact-us/index.ts +0 -48
  219. package/src/contracts/investors/data-records/index.ts +0 -113
  220. package/src/contracts/investors/data-rooms/index.ts +0 -96
  221. package/src/contracts/investors/files/index.ts +0 -167
  222. package/src/contracts/investors/files-public/index.ts +0 -185
  223. package/src/contracts/investors/index.ts +0 -72
  224. package/src/contracts/investors/individuals/index.ts +0 -99
  225. package/src/contracts/investors/investor-accounts/index.ts +0 -110
  226. package/src/contracts/investors/issuer-payment-methods/index.ts +0 -36
  227. package/src/contracts/investors/issuers/index.ts +0 -30
  228. package/src/contracts/investors/legal-entities/index.ts +0 -93
  229. package/src/contracts/investors/notes/index.ts +0 -69
  230. package/src/contracts/investors/offerings/index.ts +0 -93
  231. package/src/contracts/investors/pages/index.ts +0 -88
  232. package/src/contracts/investors/payment-methods/index.ts +0 -149
  233. package/src/contracts/investors/portfolios/index.ts +0 -53
  234. package/src/contracts/investors/sites/index.ts +0 -96
  235. package/src/contracts/investors/tasks/index.ts +0 -111
  236. package/src/contracts/investors/trade-line-items/index.ts +0 -75
  237. package/src/contracts/investors/trades/index.ts +0 -114
  238. package/src/contracts/investors/transactions/index.ts +0 -37
  239. package/src/contracts/investors/trusted-contacts/index.ts +0 -93
  240. package/src/contracts/investors/user-manuals/index.ts +0 -62
  241. package/src/contracts/investors/user-settings/index.ts +0 -170
  242. package/src/contracts/investors/users/index.ts +0 -45
  243. package/src/contracts/investors/webhooks/index.ts +0 -30
  244. package/src/contracts/issuers/account-contacts/index.ts +0 -76
  245. package/src/contracts/issuers/account-integrations/index.ts +0 -97
  246. package/src/contracts/issuers/accounts/index.ts +0 -97
  247. package/src/contracts/issuers/activities/index.ts +0 -54
  248. package/src/contracts/issuers/aic/index.ts +0 -39
  249. package/src/contracts/issuers/api-key-logs/index.ts +0 -53
  250. package/src/contracts/issuers/api-keys/index.ts +0 -93
  251. package/src/contracts/issuers/assets/index.ts +0 -122
  252. package/src/contracts/issuers/auth/index.ts +0 -152
  253. package/src/contracts/issuers/bonus-tiers/index.ts +0 -55
  254. package/src/contracts/issuers/contact-us/index.ts +0 -48
  255. package/src/contracts/issuers/covered-persons/index.ts +0 -136
  256. package/src/contracts/issuers/dashboard/index.ts +0 -72
  257. package/src/contracts/issuers/data-records/index.ts +0 -257
  258. package/src/contracts/issuers/data-rooms/index.ts +0 -134
  259. package/src/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  260. package/src/contracts/issuers/disbursement-transactions/index.ts +0 -53
  261. package/src/contracts/issuers/disbursements/index.ts +0 -153
  262. package/src/contracts/issuers/email-themes/index.ts +0 -242
  263. package/src/contracts/issuers/escrow-accounts/index.ts +0 -81
  264. package/src/contracts/issuers/exchange-api-keys/index.ts +0 -144
  265. package/src/contracts/issuers/files/index.ts +0 -166
  266. package/src/contracts/issuers/files-public/index.ts +0 -166
  267. package/src/contracts/issuers/health/index.ts +0 -24
  268. package/src/contracts/issuers/index.ts +0 -112
  269. package/src/contracts/issuers/investor-accounts/index.ts +0 -148
  270. package/src/contracts/issuers/invites/index.ts +0 -129
  271. package/src/contracts/issuers/issuer/index.ts +0 -94
  272. package/src/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  273. package/src/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  274. package/src/contracts/issuers/kyc/index.ts +0 -38
  275. package/src/contracts/issuers/login-histories/index.ts +0 -51
  276. package/src/contracts/issuers/notes/index.ts +0 -69
  277. package/src/contracts/issuers/offerings/index.ts +0 -206
  278. package/src/contracts/issuers/pages/index.ts +0 -138
  279. package/src/contracts/issuers/payment-methods/index.ts +0 -61
  280. package/src/contracts/issuers/portfolios/index.ts +0 -36
  281. package/src/contracts/issuers/rejection-reasons/index.ts +0 -32
  282. package/src/contracts/issuers/review/index.ts +0 -63
  283. package/src/contracts/issuers/secondary-customers/index.ts +0 -55
  284. package/src/contracts/issuers/secondary-orders/index.ts +0 -57
  285. package/src/contracts/issuers/secondary-trades/index.ts +0 -57
  286. package/src/contracts/issuers/secure-requests/index.ts +0 -34
  287. package/src/contracts/issuers/site-links/index.ts +0 -116
  288. package/src/contracts/issuers/site-settings/index.ts +0 -585
  289. package/src/contracts/issuers/sites/index.ts +0 -32
  290. package/src/contracts/issuers/tasks/index.ts +0 -111
  291. package/src/contracts/issuers/trades/index.ts +0 -132
  292. package/src/contracts/issuers/transactions/index.ts +0 -158
  293. package/src/contracts/issuers/user-manuals/index.ts +0 -62
  294. package/src/contracts/issuers/user-settings/index.ts +0 -170
  295. package/src/contracts/issuers/users/index.ts +0 -126
  296. package/src/contracts/secondaries/accounts/index.ts +0 -58
  297. package/src/contracts/secondaries/index.ts +0 -23
  298. package/src/contracts/secondaries/secondary-customers/index.ts +0 -55
  299. package/src/contracts/secondaries/secondary-issuers/index.ts +0 -94
  300. package/src/contracts/secondaries/secondary-orders/index.ts +0 -56
  301. package/src/contracts/secondaries/secondary-securities/index.ts +0 -95
  302. package/src/contracts/secondaries/secondary-trades/index.ts +0 -56
  303. package/types/index.mjs +0 -10320
@@ -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
- );