@dalmore/api-contracts 0.0.0-dev.a341696 → 0.0.0-dev.a367993

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 (97) hide show
  1. package/common/types/account-setting.types.d.ts +22 -66
  2. package/common/types/account-setting.types.js +2 -31
  3. package/common/types/account-setting.types.js.map +1 -1
  4. package/common/types/account.types.d.ts +32 -23
  5. package/common/types/account.types.js +1 -0
  6. package/common/types/account.types.js.map +1 -1
  7. package/common/types/activity.types.d.ts +8 -1
  8. package/common/types/activity.types.js +7 -0
  9. package/common/types/activity.types.js.map +1 -1
  10. package/common/types/asset.types.d.ts +25 -111
  11. package/common/types/asset.types.js +24 -100
  12. package/common/types/asset.types.js.map +1 -1
  13. package/common/types/auth.types.d.ts +36 -0
  14. package/common/types/auth.types.js +3 -2
  15. package/common/types/auth.types.js.map +1 -1
  16. package/common/types/bonus-tier.types.d.ts +0 -30
  17. package/common/types/cap-table.types.d.ts +177 -53
  18. package/common/types/cap-table.types.js +31 -0
  19. package/common/types/cap-table.types.js.map +1 -1
  20. package/common/types/common.types.d.ts +334 -4
  21. package/common/types/common.types.js +55 -1
  22. package/common/types/common.types.js.map +1 -1
  23. package/common/types/csv.types.d.ts +1730 -0
  24. package/common/types/csv.types.js +178 -0
  25. package/common/types/csv.types.js.map +1 -0
  26. package/common/types/disbursement-transaction.types.d.ts +1 -1
  27. package/common/types/disbursement-transaction.types.js +1 -1
  28. package/common/types/disbursement-transaction.types.js.map +1 -1
  29. package/common/types/disbursements.types.d.ts +939 -7
  30. package/common/types/disbursements.types.js +92 -2
  31. package/common/types/disbursements.types.js.map +1 -1
  32. package/common/types/exchange-provider.types.d.ts +12 -12
  33. package/common/types/file.types.d.ts +24 -0
  34. package/common/types/file.types.js +12 -0
  35. package/common/types/file.types.js.map +1 -1
  36. package/common/types/index.d.ts +4 -0
  37. package/common/types/index.js +4 -0
  38. package/common/types/index.js.map +1 -1
  39. package/common/types/individuals.types.d.ts +207 -5
  40. package/common/types/individuals.types.js +11 -14
  41. package/common/types/individuals.types.js.map +1 -1
  42. package/common/types/investor-account.types.d.ts +1 -1
  43. package/common/types/investor-account.types.js +1 -2
  44. package/common/types/investor-account.types.js.map +1 -1
  45. package/common/types/investors-offering.types.d.ts +8 -0
  46. package/common/types/investors-offering.types.js +1 -0
  47. package/common/types/investors-offering.types.js.map +1 -1
  48. package/common/types/invite.types.d.ts +2 -2
  49. package/common/types/invite.types.js +1 -1
  50. package/common/types/invite.types.js.map +1 -1
  51. package/common/types/issuer-offering.types.d.ts +182 -77
  52. package/common/types/issuer-offering.types.js +182 -45
  53. package/common/types/issuer-offering.types.js.map +1 -1
  54. package/common/types/legal-entity.types.d.ts +39 -1
  55. package/common/types/legal-entity.types.js +8 -5
  56. package/common/types/legal-entity.types.js.map +1 -1
  57. package/common/types/offering-submission.types.d.ts +198 -0
  58. package/common/types/offering-submission.types.js +16 -3
  59. package/common/types/offering-submission.types.js.map +1 -1
  60. package/common/types/offering.types.d.ts +264 -61
  61. package/common/types/offering.types.js +214 -53
  62. package/common/types/offering.types.js.map +1 -1
  63. package/common/types/portfolio.types.d.ts +6 -6
  64. package/common/types/reports.types.d.ts +345 -0
  65. package/common/types/reports.types.js +69 -0
  66. package/common/types/reports.types.js.map +1 -0
  67. package/common/types/review.types.js +1 -1
  68. package/common/types/review.types.js.map +1 -1
  69. package/common/types/secondary-order.types.d.ts +10 -10
  70. package/common/types/secondary-trade.types.d.ts +10 -10
  71. package/common/types/site.types.d.ts +12 -27
  72. package/common/types/trade-line-item.types.d.ts +24 -0
  73. package/common/types/trade-line-item.types.js +3 -0
  74. package/common/types/trade-line-item.types.js.map +1 -1
  75. package/common/types/trade.types.d.ts +10 -0
  76. package/common/types/trade.types.js +17 -1
  77. package/common/types/trade.types.js.map +1 -1
  78. package/common/types/transaction.types.d.ts +0 -1
  79. package/common/types/transaction.types.js +0 -1
  80. package/common/types/transaction.types.js.map +1 -1
  81. package/common/types/user.types.d.ts +191 -59
  82. package/common/types/user.types.js +9 -1
  83. package/common/types/user.types.js.map +1 -1
  84. package/contracts/clients/assets/index.d.ts +0 -66
  85. package/contracts/clients/csv/index.d.ts +1733 -0
  86. package/contracts/clients/csv/index.js +79 -0
  87. package/contracts/clients/csv/index.js.map +1 -0
  88. package/contracts/clients/index.d.ts +1911 -105
  89. package/contracts/clients/index.js +4 -0
  90. package/contracts/clients/index.js.map +1 -1
  91. package/contracts/clients/individuals/index.d.ts +5 -5
  92. package/contracts/clients/legal-entities/index.d.ts +1 -1
  93. package/contracts/clients/offerings/index.d.ts +88 -33
  94. package/contracts/clients/review/index.d.ts +85 -0
  95. package/contracts/clients/review/index.js +27 -0
  96. package/contracts/clients/review/index.js.map +1 -0
  97. package/package.json +1 -1
@@ -1,7 +1,6 @@
1
1
  import { z } from 'zod';
2
- import { ComplianceReview, OfferingType, ManagedByType, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType } from './common.types';
3
- import { OfferingStatus } from './issuer-offering.types';
4
- import { AssetTemplateType, InterestType } from './asset.types';
2
+ import { ComplianceReview, OfferingType, ManagedByType, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, WarrantSharesCalculationMethod } from './common.types';
3
+ import { AssetTemplateType } from './asset.types';
5
4
  export declare enum OfferingFeeType {
6
5
  FIXED = "FIXED",
7
6
  PERCENTAGE = "PERCENTAGE"
@@ -27,6 +26,14 @@ export declare const OfferingPlatformSettings: z.ZodObject<{
27
26
  export type OfferingPlatformSettings = z.infer<typeof OfferingPlatformSettings>;
28
27
  export declare const IOffering: any;
29
28
  export type IOffering = z.infer<typeof IOffering>;
29
+ export declare const QueueSoldOutOfferingsCheckResponseSchema: z.ZodObject<{
30
+ message: z.ZodString;
31
+ }, "strip", z.ZodTypeAny, {
32
+ message: string;
33
+ }, {
34
+ message: string;
35
+ }>;
36
+ export type QueueSoldOutOfferingsCheckResponse = z.infer<typeof QueueSoldOutOfferingsCheckResponseSchema>;
30
37
  export declare const IPaginatedOffering: z.ZodObject<{
31
38
  items: z.ZodArray<any, "many">;
32
39
  meta: z.ZodObject<{
@@ -113,6 +120,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
113
120
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
114
121
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
115
122
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
123
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
116
124
  }, "strip", z.ZodTypeAny, {
117
125
  platformSettings: string | null;
118
126
  type?: OfferingType | undefined;
@@ -135,6 +143,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
135
143
  memorandumId?: string | null | undefined;
136
144
  subscriptionAgreementId?: string | null | undefined;
137
145
  showTotalRaised?: boolean | undefined;
146
+ shareClassId?: string | null | undefined;
138
147
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
139
148
  subscriptionAgreementTemplateId?: string | null | undefined;
140
149
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -165,6 +174,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
165
174
  memorandumId?: string | null | undefined;
166
175
  subscriptionAgreementId?: string | null | undefined;
167
176
  showTotalRaised?: boolean | undefined;
177
+ shareClassId?: string | null | undefined;
168
178
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
169
179
  subscriptionAgreementTemplateId?: string | null | undefined;
170
180
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -214,6 +224,7 @@ export declare const PatchOffering: z.ZodObject<{
214
224
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
215
225
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
216
226
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
227
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
217
228
  } & {
218
229
  assetName: z.ZodOptional<z.ZodString>;
219
230
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -225,10 +236,7 @@ export declare const PatchOffering: z.ZodObject<{
225
236
  template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
226
237
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
227
238
  enableBonus: z.ZodOptional<z.ZodBoolean>;
228
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
229
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
230
239
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
231
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
232
240
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
233
241
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
234
242
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -269,6 +277,13 @@ export declare const PatchOffering: z.ZodObject<{
269
277
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
270
278
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
271
279
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
280
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
281
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
282
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
283
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
284
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
285
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
286
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
272
287
  }, "strip", z.ZodTypeAny, {
273
288
  platformSettings: string | null;
274
289
  type?: OfferingType | undefined;
@@ -296,6 +311,14 @@ export declare const PatchOffering: z.ZodObject<{
296
311
  escrowAgreementFileId?: string | null | undefined;
297
312
  bankAccountId?: string | null | undefined;
298
313
  escrowAccountId?: string | null | undefined;
314
+ warrantsEnabled?: boolean | undefined;
315
+ totalShares?: number | null | undefined;
316
+ warrantTermYears?: number | null | undefined;
317
+ exercisePrice?: number | null | undefined;
318
+ warrantPercentage?: number | null | undefined;
319
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
320
+ incrementThreshold?: number | null | undefined;
321
+ shareClassId?: string | null | undefined;
299
322
  assetName?: string | undefined;
300
323
  assetType?: AssetType | undefined;
301
324
  pricePerUnit?: number | null | undefined;
@@ -305,10 +328,7 @@ export declare const PatchOffering: z.ZodObject<{
305
328
  durationType?: DurationType | null | undefined;
306
329
  tiers?: number[] | null | undefined;
307
330
  enableBonus?: boolean | undefined;
308
- principalAmount?: number | null | undefined;
309
- maxTotalRaise?: number | null | undefined;
310
331
  interestRate?: number | null | undefined;
311
- interestType?: InterestType | null | undefined;
312
332
  bonusTiers?: {
313
333
  value: number;
314
334
  type: import("./bonus-tier.types").BonusType;
@@ -350,6 +370,14 @@ export declare const PatchOffering: z.ZodObject<{
350
370
  escrowAgreementFileId?: string | null | undefined;
351
371
  bankAccountId?: string | null | undefined;
352
372
  escrowAccountId?: string | null | undefined;
373
+ warrantsEnabled?: boolean | undefined;
374
+ totalShares?: number | null | undefined;
375
+ warrantTermYears?: number | null | undefined;
376
+ exercisePrice?: number | null | undefined;
377
+ warrantPercentage?: number | null | undefined;
378
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
379
+ incrementThreshold?: number | null | undefined;
380
+ shareClassId?: string | null | undefined;
353
381
  assetName?: string | undefined;
354
382
  assetType?: AssetType | undefined;
355
383
  pricePerUnit?: number | null | undefined;
@@ -359,10 +387,7 @@ export declare const PatchOffering: z.ZodObject<{
359
387
  durationType?: DurationType | null | undefined;
360
388
  tiers?: number[] | null | undefined;
361
389
  enableBonus?: boolean | undefined;
362
- principalAmount?: number | null | undefined;
363
- maxTotalRaise?: number | null | undefined;
364
390
  interestRate?: number | null | undefined;
365
- interestType?: InterestType | null | undefined;
366
391
  bonusTiers?: {
367
392
  value: number;
368
393
  type: import("./bonus-tier.types").BonusType;
@@ -374,6 +399,48 @@ export declare const PatchOffering: z.ZodObject<{
374
399
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
375
400
  }>;
376
401
  export type PatchOffering = z.infer<typeof PatchOffering>;
402
+ /**
403
+ * Optional params for resolveAndValidateOfferingUpdateFields.
404
+ * All fields are optional and nullable; resolution merges with offering/asset values.
405
+ */
406
+ export declare const ResolveOfferingUpdateFieldsParamsZod: z.ZodObject<{
407
+ minInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
408
+ maxInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
409
+ targetAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
410
+ pricePerUnit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
411
+ }, "strip", z.ZodTypeAny, {
412
+ targetAmount?: number | null | undefined;
413
+ minInvestment?: number | null | undefined;
414
+ maxInvestment?: number | null | undefined;
415
+ pricePerUnit?: number | null | undefined;
416
+ }, {
417
+ targetAmount?: number | null | undefined;
418
+ minInvestment?: number | null | undefined;
419
+ maxInvestment?: number | null | undefined;
420
+ pricePerUnit?: number | null | undefined;
421
+ }>;
422
+ export type ResolveOfferingUpdateFieldsParams = z.infer<typeof ResolveOfferingUpdateFieldsParamsZod>;
423
+ /**
424
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
425
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
426
+ */
427
+ export declare const ResolvedOfferingUpdateFieldsZod: z.ZodObject<{
428
+ pricePerUnit: z.ZodNumber;
429
+ targetAmount: z.ZodNumber;
430
+ minInvestment: z.ZodNullable<z.ZodNumber>;
431
+ maxInvestment: z.ZodNullable<z.ZodNumber>;
432
+ }, "strip", z.ZodTypeAny, {
433
+ targetAmount: number;
434
+ minInvestment: number | null;
435
+ maxInvestment: number | null;
436
+ pricePerUnit: number;
437
+ }, {
438
+ targetAmount: number;
439
+ minInvestment: number | null;
440
+ maxInvestment: number | null;
441
+ pricePerUnit: number;
442
+ }>;
443
+ export type ResolvedOfferingUpdateFields = z.infer<typeof ResolvedOfferingUpdateFieldsZod>;
377
444
  export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
378
445
  name: z.ZodOptional<z.ZodString>;
379
446
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -416,11 +483,11 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
416
483
  subscriptionAgreementId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
417
484
  jointSubscriptionAgreementTemplateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
418
485
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
419
- showTotalRaised: z.ZodOptional<z.ZodBoolean>;
420
486
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
421
487
  } & {
422
488
  accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
423
489
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
490
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
424
491
  assetName: z.ZodString;
425
492
  assetType: z.ZodNativeEnum<typeof AssetType>;
426
493
  pricePerUnit: z.ZodNullable<z.ZodNumber>;
@@ -434,10 +501,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
434
501
  hasEscrow: z.ZodOptional<z.ZodBoolean>;
435
502
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
436
503
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
437
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
438
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
439
504
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
440
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
441
505
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
442
506
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
443
507
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -474,10 +538,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
474
538
  startAmount: number;
475
539
  endAmount: number;
476
540
  }>, "many">>;
541
+ warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
542
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
543
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
544
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
545
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
546
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
547
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
548
+ showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
477
549
  }, "strip", z.ZodTypeAny, {
478
550
  accountId: string;
479
551
  template: AssetTemplateType;
480
552
  platformSettings: string | null;
553
+ warrantsEnabled: boolean;
481
554
  assetName: string;
482
555
  assetType: AssetType;
483
556
  pricePerUnit: number | null;
@@ -505,15 +578,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
505
578
  hasEscrow?: boolean | undefined;
506
579
  bankAccountId?: string | null | undefined;
507
580
  escrowAccountId?: string | null | undefined;
581
+ totalShares?: number | null | undefined;
582
+ warrantTermYears?: number | null | undefined;
583
+ exercisePrice?: number | null | undefined;
584
+ warrantPercentage?: number | null | undefined;
585
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
586
+ incrementThreshold?: number | null | undefined;
587
+ shareClassId?: string | null | undefined;
508
588
  yield?: number | null | undefined;
509
589
  duration?: number | null | undefined;
510
590
  durationType?: DurationType | null | undefined;
511
591
  tiers?: number[] | null | undefined;
512
592
  enableBonus?: boolean | undefined;
513
- principalAmount?: number | null | undefined;
514
- maxTotalRaise?: number | null | undefined;
515
593
  interestRate?: number | null | undefined;
516
- interestType?: InterestType | null | undefined;
517
594
  bonusTiers?: {
518
595
  value: number;
519
596
  type: import("./bonus-tier.types").BonusType;
@@ -559,15 +636,20 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
559
636
  hasEscrow?: boolean | undefined;
560
637
  bankAccountId?: string | null | undefined;
561
638
  escrowAccountId?: string | null | undefined;
639
+ warrantsEnabled?: boolean | undefined;
640
+ totalShares?: number | null | undefined;
641
+ warrantTermYears?: number | null | undefined;
642
+ exercisePrice?: number | null | undefined;
643
+ warrantPercentage?: number | null | undefined;
644
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
645
+ incrementThreshold?: number | null | undefined;
646
+ shareClassId?: string | null | undefined;
562
647
  yield?: number | null | undefined;
563
648
  duration?: number | null | undefined;
564
649
  durationType?: DurationType | null | undefined;
565
650
  tiers?: number[] | null | undefined;
566
651
  enableBonus?: boolean | undefined;
567
- principalAmount?: number | null | undefined;
568
- maxTotalRaise?: number | null | undefined;
569
652
  interestRate?: number | null | undefined;
570
- interestType?: InterestType | null | undefined;
571
653
  bonusTiers?: {
572
654
  value: number;
573
655
  type: import("./bonus-tier.types").BonusType;
@@ -581,6 +663,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
581
663
  accountId: string;
582
664
  template: AssetTemplateType;
583
665
  platformSettings: string | null;
666
+ warrantsEnabled: boolean;
584
667
  assetName: string;
585
668
  assetType: AssetType;
586
669
  pricePerUnit: number | null;
@@ -608,15 +691,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
608
691
  hasEscrow?: boolean | undefined;
609
692
  bankAccountId?: string | null | undefined;
610
693
  escrowAccountId?: string | null | undefined;
694
+ totalShares?: number | null | undefined;
695
+ warrantTermYears?: number | null | undefined;
696
+ exercisePrice?: number | null | undefined;
697
+ warrantPercentage?: number | null | undefined;
698
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
699
+ incrementThreshold?: number | null | undefined;
700
+ shareClassId?: string | null | undefined;
611
701
  yield?: number | null | undefined;
612
702
  duration?: number | null | undefined;
613
703
  durationType?: DurationType | null | undefined;
614
704
  tiers?: number[] | null | undefined;
615
705
  enableBonus?: boolean | undefined;
616
- principalAmount?: number | null | undefined;
617
- maxTotalRaise?: number | null | undefined;
618
706
  interestRate?: number | null | undefined;
619
- interestType?: InterestType | null | undefined;
620
707
  bonusTiers?: {
621
708
  value: number;
622
709
  type: import("./bonus-tier.types").BonusType;
@@ -662,15 +749,20 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
662
749
  hasEscrow?: boolean | undefined;
663
750
  bankAccountId?: string | null | undefined;
664
751
  escrowAccountId?: string | null | undefined;
752
+ warrantsEnabled?: boolean | undefined;
753
+ totalShares?: number | null | undefined;
754
+ warrantTermYears?: number | null | undefined;
755
+ exercisePrice?: number | null | undefined;
756
+ warrantPercentage?: number | null | undefined;
757
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
758
+ incrementThreshold?: number | null | undefined;
759
+ shareClassId?: string | null | undefined;
665
760
  yield?: number | null | undefined;
666
761
  duration?: number | null | undefined;
667
762
  durationType?: DurationType | null | undefined;
668
763
  tiers?: number[] | null | undefined;
669
764
  enableBonus?: boolean | undefined;
670
- principalAmount?: number | null | undefined;
671
- maxTotalRaise?: number | null | undefined;
672
765
  interestRate?: number | null | undefined;
673
- interestType?: InterestType | null | undefined;
674
766
  bonusTiers?: {
675
767
  value: number;
676
768
  type: import("./bonus-tier.types").BonusType;
@@ -682,7 +774,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
682
774
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
683
775
  }>;
684
776
  export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
685
- export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount"]>;
777
+ export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount", "shareClass"]>;
686
778
  /**
687
779
  * @description Query parameters for including related entities
688
780
  * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
@@ -697,23 +789,27 @@ export declare const OfferingsIncludeQuery: z.ZodObject<{
697
789
  export interface OfferingsIncludeQuery extends z.infer<typeof OfferingsIncludeQuery> {
698
790
  }
699
791
  /**
700
- * @description
701
- * Filters for querying offerings.
792
+ * Filters supported for querying offerings.
702
793
  *
703
- * The "combinedStatus" filter provides a unified status that combines three separate fields:
704
- * - complianceReview: The compliance review status of the offering
705
- * - onboardingStatus: The onboarding completion status
706
- * - enabled: Whether the offering is currently enabled/active
794
+ * Available fields:
795
+ * - `issuerName`: (string, optional) Filter by name of the issuer.
796
+ * - `name`: (string, optional) Filter by offering name.
797
+ * - `accountId`: (AccountId, optional) Filter by tenant/account ID.
798
+ * - `issuerId`: (IssuerId, optional) Filter by issuer ID.
799
+ * - `type`: (OfferingType, optional) Filter by offering type.
800
+ * - `status`: (ComplianceReview, optional) Filter by compliance review status.
801
+ * - `enabled`: (boolean, optional) Filter for enabled/active offerings.
802
+ * - `managedBy`: (ManagedByType, optional) Filter by which system or user manages the offering.
803
+ * - `versioningType`: (OfferingVersioningType, optional) Filter by versioning strategy.
804
+ * - `onboardingStatus`: (OfferingOnboardingStatus, optional) Filter by issuer onboarding status.
707
805
  *
708
- * The combinedStatus is calculated using the following priority rules:
709
- * 1. If onboardingStatus is "IN_REVIEW" combinedStatus = "ONBOARDING"
710
- * 2. Else if complianceReview is not "APPROVED" → combinedStatus = "IN_COMPLIANCE_REVIEW"
711
- * 3. Else if onboardingStatus is "COMPLETE" and complianceReview is "APPROVED" →
712
- * - If enabled is true → combinedStatus = "ACTIVE"
713
- * - If enabled is false → combinedStatus = "PAUSED"
806
+ * @remarks
807
+ * These filters can be combined to query offerings across multiple dimensions.
714
808
  *
715
- * This allows for filtering offerings by a single summary state that reflects the overall user-facing status,
716
- * rather than requiring separate filters for each individual field.
809
+ * Example use:
810
+ * ```ts
811
+ * { issuerName: "ABC Capital", type: OfferingType.REG_A }
812
+ * ```
717
813
  */
718
814
  export declare const OfferingFiltersZod: z.ZodObject<{
719
815
  issuerName: z.ZodOptional<z.ZodString>;
@@ -725,32 +821,32 @@ export declare const OfferingFiltersZod: z.ZodObject<{
725
821
  enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
726
822
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
727
823
  versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
728
- combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
729
824
  onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingOnboardingStatus>>;
825
+ complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
730
826
  }, "strip", z.ZodTypeAny, {
731
827
  type?: OfferingType | undefined;
732
828
  status?: ComplianceReview | undefined;
733
829
  accountId?: string | undefined;
734
830
  name?: string | undefined;
735
831
  managedBy?: ManagedByType | undefined;
832
+ complianceReview?: ComplianceReview | undefined;
736
833
  onboardingStatus?: OfferingOnboardingStatus | undefined;
737
834
  enabled?: boolean | undefined;
738
835
  issuerId?: string | undefined;
739
836
  issuerName?: string | undefined;
740
837
  versioningType?: OfferingVersioningType | undefined;
741
- combinedStatus?: OfferingStatus | undefined;
742
838
  }, {
743
839
  type?: OfferingType | undefined;
744
840
  status?: ComplianceReview | undefined;
745
841
  accountId?: string | undefined;
746
842
  name?: string | undefined;
747
843
  managedBy?: ManagedByType | undefined;
844
+ complianceReview?: ComplianceReview | undefined;
748
845
  onboardingStatus?: OfferingOnboardingStatus | undefined;
749
846
  enabled?: unknown;
750
847
  issuerId?: string | undefined;
751
848
  issuerName?: string | undefined;
752
849
  versioningType?: OfferingVersioningType | undefined;
753
- combinedStatus?: OfferingStatus | undefined;
754
850
  }>;
755
851
  export type OfferingFiltersZod = z.infer<typeof OfferingFiltersZod>;
756
852
  export declare const OfferingSortZod: z.ZodObject<{
@@ -1220,6 +1316,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1220
1316
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
1221
1317
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
1222
1318
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
1319
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1223
1320
  } & {
1224
1321
  assetName: z.ZodOptional<z.ZodString>;
1225
1322
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -1231,10 +1328,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1231
1328
  template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
1232
1329
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
1233
1330
  enableBonus: z.ZodOptional<z.ZodBoolean>;
1234
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1235
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1236
1331
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1237
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
1238
1332
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
1239
1333
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
1240
1334
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -1275,6 +1369,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1275
1369
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1276
1370
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1277
1371
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1372
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
1373
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1374
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1375
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1376
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1377
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
1378
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1278
1379
  }, "strip", z.ZodTypeAny, {
1279
1380
  platformSettings: string | null;
1280
1381
  type?: OfferingType | undefined;
@@ -1302,6 +1403,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1302
1403
  escrowAgreementFileId?: string | null | undefined;
1303
1404
  bankAccountId?: string | null | undefined;
1304
1405
  escrowAccountId?: string | null | undefined;
1406
+ warrantsEnabled?: boolean | undefined;
1407
+ totalShares?: number | null | undefined;
1408
+ warrantTermYears?: number | null | undefined;
1409
+ exercisePrice?: number | null | undefined;
1410
+ warrantPercentage?: number | null | undefined;
1411
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1412
+ incrementThreshold?: number | null | undefined;
1413
+ shareClassId?: string | null | undefined;
1305
1414
  assetName?: string | undefined;
1306
1415
  assetType?: AssetType | undefined;
1307
1416
  pricePerUnit?: number | null | undefined;
@@ -1311,10 +1420,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1311
1420
  durationType?: DurationType | null | undefined;
1312
1421
  tiers?: number[] | null | undefined;
1313
1422
  enableBonus?: boolean | undefined;
1314
- principalAmount?: number | null | undefined;
1315
- maxTotalRaise?: number | null | undefined;
1316
1423
  interestRate?: number | null | undefined;
1317
- interestType?: InterestType | null | undefined;
1318
1424
  bonusTiers?: {
1319
1425
  value: number;
1320
1426
  type: import("./bonus-tier.types").BonusType;
@@ -1356,6 +1462,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1356
1462
  escrowAgreementFileId?: string | null | undefined;
1357
1463
  bankAccountId?: string | null | undefined;
1358
1464
  escrowAccountId?: string | null | undefined;
1465
+ warrantsEnabled?: boolean | undefined;
1466
+ totalShares?: number | null | undefined;
1467
+ warrantTermYears?: number | null | undefined;
1468
+ exercisePrice?: number | null | undefined;
1469
+ warrantPercentage?: number | null | undefined;
1470
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1471
+ incrementThreshold?: number | null | undefined;
1472
+ shareClassId?: string | null | undefined;
1359
1473
  assetName?: string | undefined;
1360
1474
  assetType?: AssetType | undefined;
1361
1475
  pricePerUnit?: number | null | undefined;
@@ -1365,10 +1479,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1365
1479
  durationType?: DurationType | null | undefined;
1366
1480
  tiers?: number[] | null | undefined;
1367
1481
  enableBonus?: boolean | undefined;
1368
- principalAmount?: number | null | undefined;
1369
- maxTotalRaise?: number | null | undefined;
1370
1482
  interestRate?: number | null | undefined;
1371
- interestType?: InterestType | null | undefined;
1372
1483
  bonusTiers?: {
1373
1484
  value: number;
1374
1485
  type: import("./bonus-tier.types").BonusType;
@@ -1636,6 +1747,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1636
1747
  escrowAgreementFileId?: string | null | undefined;
1637
1748
  bankAccountId?: string | null | undefined;
1638
1749
  escrowAccountId?: string | null | undefined;
1750
+ warrantsEnabled?: boolean | undefined;
1751
+ totalShares?: number | null | undefined;
1752
+ warrantTermYears?: number | null | undefined;
1753
+ exercisePrice?: number | null | undefined;
1754
+ warrantPercentage?: number | null | undefined;
1755
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1756
+ incrementThreshold?: number | null | undefined;
1757
+ shareClassId?: string | null | undefined;
1639
1758
  assetName?: string | undefined;
1640
1759
  assetType?: AssetType | undefined;
1641
1760
  pricePerUnit?: number | null | undefined;
@@ -1645,10 +1764,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1645
1764
  durationType?: DurationType | null | undefined;
1646
1765
  tiers?: number[] | null | undefined;
1647
1766
  enableBonus?: boolean | undefined;
1648
- principalAmount?: number | null | undefined;
1649
- maxTotalRaise?: number | null | undefined;
1650
1767
  interestRate?: number | null | undefined;
1651
- interestType?: InterestType | null | undefined;
1652
1768
  bonusTiers?: {
1653
1769
  value: number;
1654
1770
  type: import("./bonus-tier.types").BonusType;
@@ -1701,6 +1817,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1701
1817
  escrowAgreementFileId?: string | null | undefined;
1702
1818
  bankAccountId?: string | null | undefined;
1703
1819
  escrowAccountId?: string | null | undefined;
1820
+ warrantsEnabled?: boolean | undefined;
1821
+ totalShares?: number | null | undefined;
1822
+ warrantTermYears?: number | null | undefined;
1823
+ exercisePrice?: number | null | undefined;
1824
+ warrantPercentage?: number | null | undefined;
1825
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1826
+ incrementThreshold?: number | null | undefined;
1827
+ shareClassId?: string | null | undefined;
1704
1828
  assetName?: string | undefined;
1705
1829
  assetType?: AssetType | undefined;
1706
1830
  pricePerUnit?: number | null | undefined;
@@ -1710,10 +1834,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1710
1834
  durationType?: DurationType | null | undefined;
1711
1835
  tiers?: number[] | null | undefined;
1712
1836
  enableBonus?: boolean | undefined;
1713
- principalAmount?: number | null | undefined;
1714
- maxTotalRaise?: number | null | undefined;
1715
1837
  interestRate?: number | null | undefined;
1716
- interestType?: InterestType | null | undefined;
1717
1838
  bonusTiers?: {
1718
1839
  value: number;
1719
1840
  type: import("./bonus-tier.types").BonusType;
@@ -2457,6 +2578,7 @@ export type OfferingUpdateFields = {
2457
2578
  managedBy?: ManagedByType | null;
2458
2579
  showTotalRaised?: boolean;
2459
2580
  enabled?: boolean;
2581
+ shareClassId?: string | null;
2460
2582
  };
2461
2583
  export declare const ReviewOfferingOnboarding: z.ZodObject<{
2462
2584
  onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
@@ -2652,3 +2774,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
2652
2774
  currentEscrowAgreementFileId: string | null;
2653
2775
  }>;
2654
2776
  export type EscrowValidationContext = z.infer<typeof EscrowValidationContextZod>;
2777
+ /**
2778
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
2779
+ */
2780
+ export declare const WarrantSharesBaseZod: z.ZodObject<{
2781
+ warrantsEnabled: z.ZodBoolean;
2782
+ totalShares: z.ZodNullable<z.ZodNumber>;
2783
+ warrantTermYears: z.ZodNullable<z.ZodNumber>;
2784
+ exercisePrice: z.ZodNullable<z.ZodNumber>;
2785
+ warrantPercentage: z.ZodNullable<z.ZodNumber>;
2786
+ calculationMethod: z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>;
2787
+ incrementThreshold: z.ZodNullable<z.ZodNumber>;
2788
+ fullyDilutedShares: z.ZodNullable<z.ZodNumber>;
2789
+ }, "strip", z.ZodTypeAny, {
2790
+ warrantsEnabled: boolean;
2791
+ totalShares: number | null;
2792
+ warrantTermYears: number | null;
2793
+ exercisePrice: number | null;
2794
+ warrantPercentage: number | null;
2795
+ calculationMethod: WarrantSharesCalculationMethod | null;
2796
+ incrementThreshold: number | null;
2797
+ fullyDilutedShares: number | null;
2798
+ }, {
2799
+ warrantsEnabled: boolean;
2800
+ totalShares: number | null;
2801
+ warrantTermYears: number | null;
2802
+ exercisePrice: number | null;
2803
+ warrantPercentage: number | null;
2804
+ calculationMethod: WarrantSharesCalculationMethod | null;
2805
+ incrementThreshold: number | null;
2806
+ fullyDilutedShares: number | null;
2807
+ }>;
2808
+ export type WarrantSharesBase = z.infer<typeof WarrantSharesBaseZod>;
2809
+ /**
2810
+ * All warrant field keys used when picking warrant data from base or patch.
2811
+ */
2812
+ export declare const WARRANT_FIELD_KEYS: (keyof WarrantSharesBase)[];
2813
+ /**
2814
+ * Warrant field keys required when enabling warrants (turning warrants on).
2815
+ */
2816
+ export declare const WARRANT_REQUIRED_WHEN_ENABLED_KEYS: (keyof WarrantSharesBase)[];
2817
+ /**
2818
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
2819
+ */
2820
+ export declare const WarrantValidationDataZod: z.ZodObject<{
2821
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
2822
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2823
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2824
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2825
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2826
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
2827
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2828
+ fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2829
+ }, "strip", z.ZodTypeAny, {
2830
+ warrantsEnabled?: boolean | undefined;
2831
+ totalShares?: number | null | undefined;
2832
+ warrantTermYears?: number | null | undefined;
2833
+ exercisePrice?: number | null | undefined;
2834
+ warrantPercentage?: number | null | undefined;
2835
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2836
+ incrementThreshold?: number | null | undefined;
2837
+ fullyDilutedShares?: number | null | undefined;
2838
+ }, {
2839
+ warrantsEnabled?: boolean | undefined;
2840
+ totalShares?: number | null | undefined;
2841
+ warrantTermYears?: number | null | undefined;
2842
+ exercisePrice?: number | null | undefined;
2843
+ warrantPercentage?: number | null | undefined;
2844
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2845
+ incrementThreshold?: number | null | undefined;
2846
+ fullyDilutedShares?: number | null | undefined;
2847
+ }>;
2848
+ export type WarrantValidationData = z.infer<typeof WarrantValidationDataZod>;
2849
+ /**
2850
+ * Validated warrant payload to persist on revision and offering.
2851
+ */
2852
+ export type WarrantValidationResult = WarrantSharesBase;
2853
+ /**
2854
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
2855
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
2856
+ */
2857
+ export declare const WARRANT_DISABLED_FIELD_RESETS: WarrantValidationResult;