@dalmore/api-contracts 0.0.0-dev.f1cb508 → 0.0.0-dev.f317bb8

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 (103) 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 +34 -25
  8. package/common/types/activity.types.js +11 -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 +340 -3
  21. package/common/types/common.types.js +59 -1
  22. package/common/types/common.types.js.map +1 -1
  23. package/common/types/csv.types.d.ts +1557 -0
  24. package/common/types/csv.types.js +154 -0
  25. package/common/types/csv.types.js.map +1 -0
  26. package/common/types/dashboard.types.d.ts +7 -7
  27. package/common/types/disbursement-transaction.types.d.ts +1 -1
  28. package/common/types/disbursement-transaction.types.js +1 -1
  29. package/common/types/disbursement-transaction.types.js.map +1 -1
  30. package/common/types/disbursements.types.d.ts +956 -7
  31. package/common/types/disbursements.types.js +92 -2
  32. package/common/types/disbursements.types.js.map +1 -1
  33. package/common/types/escrow-account.types.d.ts +17 -0
  34. package/common/types/escrow-account.types.js +3 -0
  35. package/common/types/escrow-account.types.js.map +1 -1
  36. package/common/types/exchange-provider.types.d.ts +12 -12
  37. package/common/types/file.types.d.ts +33 -9
  38. package/common/types/file.types.js +12 -0
  39. package/common/types/file.types.js.map +1 -1
  40. package/common/types/index.d.ts +4 -0
  41. package/common/types/index.js +4 -0
  42. package/common/types/index.js.map +1 -1
  43. package/common/types/individuals.types.d.ts +207 -5
  44. package/common/types/individuals.types.js +11 -14
  45. package/common/types/individuals.types.js.map +1 -1
  46. package/common/types/investor-account.types.d.ts +1 -1
  47. package/common/types/investor-account.types.js +1 -2
  48. package/common/types/investor-account.types.js.map +1 -1
  49. package/common/types/invite.types.d.ts +2 -2
  50. package/common/types/invite.types.js +1 -1
  51. package/common/types/invite.types.js.map +1 -1
  52. package/common/types/issuer-offering.types.d.ts +186 -77
  53. package/common/types/issuer-offering.types.js +181 -45
  54. package/common/types/issuer-offering.types.js.map +1 -1
  55. package/common/types/job-item.types.d.ts +14 -14
  56. package/common/types/legal-entity.types.d.ts +39 -1
  57. package/common/types/legal-entity.types.js +8 -5
  58. package/common/types/legal-entity.types.js.map +1 -1
  59. package/common/types/note.types.d.ts +15 -15
  60. package/common/types/offering-submission.types.d.ts +198 -0
  61. package/common/types/offering-submission.types.js +16 -3
  62. package/common/types/offering-submission.types.js.map +1 -1
  63. package/common/types/offering.types.d.ts +256 -61
  64. package/common/types/offering.types.js +210 -53
  65. package/common/types/offering.types.js.map +1 -1
  66. package/common/types/portfolio.types.d.ts +6 -6
  67. package/common/types/reports.types.d.ts +345 -0
  68. package/common/types/reports.types.js +69 -0
  69. package/common/types/reports.types.js.map +1 -0
  70. package/common/types/review.types.js +1 -1
  71. package/common/types/review.types.js.map +1 -1
  72. package/common/types/secondary-order.types.d.ts +10 -10
  73. package/common/types/secondary-trade.types.d.ts +10 -10
  74. package/common/types/site.types.d.ts +12 -27
  75. package/common/types/task.types.d.ts +22 -22
  76. package/common/types/trade-line-item.types.d.ts +24 -0
  77. package/common/types/trade-line-item.types.js +3 -0
  78. package/common/types/trade-line-item.types.js.map +1 -1
  79. package/common/types/trade.types.d.ts +9 -0
  80. package/common/types/trade.types.js +8 -1
  81. package/common/types/trade.types.js.map +1 -1
  82. package/common/types/transaction.types.d.ts +0 -1
  83. package/common/types/transaction.types.js +0 -1
  84. package/common/types/transaction.types.js.map +1 -1
  85. package/common/types/user.types.d.ts +191 -59
  86. package/common/types/user.types.js +9 -1
  87. package/common/types/user.types.js.map +1 -1
  88. package/contracts/clients/assets/index.d.ts +0 -66
  89. package/contracts/clients/csv/index.d.ts +1594 -0
  90. package/contracts/clients/csv/index.js +62 -0
  91. package/contracts/clients/csv/index.js.map +1 -0
  92. package/contracts/clients/files/index.d.ts +3 -3
  93. package/contracts/clients/files-public/index.d.ts +3 -3
  94. package/contracts/clients/index.d.ts +1778 -111
  95. package/contracts/clients/index.js +4 -0
  96. package/contracts/clients/index.js.map +1 -1
  97. package/contracts/clients/individuals/index.d.ts +5 -5
  98. package/contracts/clients/legal-entities/index.d.ts +1 -1
  99. package/contracts/clients/offerings/index.d.ts +88 -33
  100. package/contracts/clients/review/index.d.ts +85 -0
  101. package/contracts/clients/review/index.js +27 -0
  102. package/contracts/clients/review/index.js.map +1 -0
  103. 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"
@@ -113,6 +112,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
113
112
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
114
113
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
115
114
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
115
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
116
116
  }, "strip", z.ZodTypeAny, {
117
117
  platformSettings: string | null;
118
118
  type?: OfferingType | undefined;
@@ -135,6 +135,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
135
135
  memorandumId?: string | null | undefined;
136
136
  subscriptionAgreementId?: string | null | undefined;
137
137
  showTotalRaised?: boolean | undefined;
138
+ shareClassId?: string | null | undefined;
138
139
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
139
140
  subscriptionAgreementTemplateId?: string | null | undefined;
140
141
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -165,6 +166,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
165
166
  memorandumId?: string | null | undefined;
166
167
  subscriptionAgreementId?: string | null | undefined;
167
168
  showTotalRaised?: boolean | undefined;
169
+ shareClassId?: string | null | undefined;
168
170
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
169
171
  subscriptionAgreementTemplateId?: string | null | undefined;
170
172
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -214,6 +216,7 @@ export declare const PatchOffering: z.ZodObject<{
214
216
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
215
217
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
216
218
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
219
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
217
220
  } & {
218
221
  assetName: z.ZodOptional<z.ZodString>;
219
222
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -225,10 +228,7 @@ export declare const PatchOffering: z.ZodObject<{
225
228
  template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
226
229
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
227
230
  enableBonus: z.ZodOptional<z.ZodBoolean>;
228
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
229
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
230
231
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
231
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
232
232
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
233
233
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
234
234
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -269,6 +269,13 @@ export declare const PatchOffering: z.ZodObject<{
269
269
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
270
270
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
271
271
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
272
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
273
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
274
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
275
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
276
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
277
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
278
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
272
279
  }, "strip", z.ZodTypeAny, {
273
280
  platformSettings: string | null;
274
281
  type?: OfferingType | undefined;
@@ -296,6 +303,14 @@ export declare const PatchOffering: z.ZodObject<{
296
303
  escrowAgreementFileId?: string | null | undefined;
297
304
  bankAccountId?: string | null | undefined;
298
305
  escrowAccountId?: string | null | undefined;
306
+ warrantsEnabled?: boolean | undefined;
307
+ totalShares?: number | null | undefined;
308
+ warrantTermYears?: number | null | undefined;
309
+ exercisePrice?: number | null | undefined;
310
+ warrantPercentage?: number | null | undefined;
311
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
312
+ incrementThreshold?: number | null | undefined;
313
+ shareClassId?: string | null | undefined;
299
314
  assetName?: string | undefined;
300
315
  assetType?: AssetType | undefined;
301
316
  pricePerUnit?: number | null | undefined;
@@ -305,10 +320,7 @@ export declare const PatchOffering: z.ZodObject<{
305
320
  durationType?: DurationType | null | undefined;
306
321
  tiers?: number[] | null | undefined;
307
322
  enableBonus?: boolean | undefined;
308
- principalAmount?: number | null | undefined;
309
- maxTotalRaise?: number | null | undefined;
310
323
  interestRate?: number | null | undefined;
311
- interestType?: InterestType | null | undefined;
312
324
  bonusTiers?: {
313
325
  value: number;
314
326
  type: import("./bonus-tier.types").BonusType;
@@ -350,6 +362,14 @@ export declare const PatchOffering: z.ZodObject<{
350
362
  escrowAgreementFileId?: string | null | undefined;
351
363
  bankAccountId?: string | null | undefined;
352
364
  escrowAccountId?: string | null | undefined;
365
+ warrantsEnabled?: boolean | undefined;
366
+ totalShares?: number | null | undefined;
367
+ warrantTermYears?: number | null | undefined;
368
+ exercisePrice?: number | null | undefined;
369
+ warrantPercentage?: number | null | undefined;
370
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
371
+ incrementThreshold?: number | null | undefined;
372
+ shareClassId?: string | null | undefined;
353
373
  assetName?: string | undefined;
354
374
  assetType?: AssetType | undefined;
355
375
  pricePerUnit?: number | null | undefined;
@@ -359,10 +379,7 @@ export declare const PatchOffering: z.ZodObject<{
359
379
  durationType?: DurationType | null | undefined;
360
380
  tiers?: number[] | null | undefined;
361
381
  enableBonus?: boolean | undefined;
362
- principalAmount?: number | null | undefined;
363
- maxTotalRaise?: number | null | undefined;
364
382
  interestRate?: number | null | undefined;
365
- interestType?: InterestType | null | undefined;
366
383
  bonusTiers?: {
367
384
  value: number;
368
385
  type: import("./bonus-tier.types").BonusType;
@@ -374,6 +391,48 @@ export declare const PatchOffering: z.ZodObject<{
374
391
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
375
392
  }>;
376
393
  export type PatchOffering = z.infer<typeof PatchOffering>;
394
+ /**
395
+ * Optional params for resolveAndValidateOfferingUpdateFields.
396
+ * All fields are optional and nullable; resolution merges with offering/asset values.
397
+ */
398
+ export declare const ResolveOfferingUpdateFieldsParamsZod: z.ZodObject<{
399
+ minInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
400
+ maxInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
401
+ targetAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
402
+ pricePerUnit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
403
+ }, "strip", z.ZodTypeAny, {
404
+ targetAmount?: number | null | undefined;
405
+ minInvestment?: number | null | undefined;
406
+ maxInvestment?: number | null | undefined;
407
+ pricePerUnit?: number | null | undefined;
408
+ }, {
409
+ targetAmount?: number | null | undefined;
410
+ minInvestment?: number | null | undefined;
411
+ maxInvestment?: number | null | undefined;
412
+ pricePerUnit?: number | null | undefined;
413
+ }>;
414
+ export type ResolveOfferingUpdateFieldsParams = z.infer<typeof ResolveOfferingUpdateFieldsParamsZod>;
415
+ /**
416
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
417
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
418
+ */
419
+ export declare const ResolvedOfferingUpdateFieldsZod: z.ZodObject<{
420
+ pricePerUnit: z.ZodNumber;
421
+ targetAmount: z.ZodNumber;
422
+ minInvestment: z.ZodNullable<z.ZodNumber>;
423
+ maxInvestment: z.ZodNullable<z.ZodNumber>;
424
+ }, "strip", z.ZodTypeAny, {
425
+ targetAmount: number;
426
+ minInvestment: number | null;
427
+ maxInvestment: number | null;
428
+ pricePerUnit: number;
429
+ }, {
430
+ targetAmount: number;
431
+ minInvestment: number | null;
432
+ maxInvestment: number | null;
433
+ pricePerUnit: number;
434
+ }>;
435
+ export type ResolvedOfferingUpdateFields = z.infer<typeof ResolvedOfferingUpdateFieldsZod>;
377
436
  export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
378
437
  name: z.ZodOptional<z.ZodString>;
379
438
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -416,11 +475,11 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
416
475
  subscriptionAgreementId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
417
476
  jointSubscriptionAgreementTemplateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
418
477
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
419
- showTotalRaised: z.ZodOptional<z.ZodBoolean>;
420
478
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
421
479
  } & {
422
480
  accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
423
481
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
482
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
424
483
  assetName: z.ZodString;
425
484
  assetType: z.ZodNativeEnum<typeof AssetType>;
426
485
  pricePerUnit: z.ZodNullable<z.ZodNumber>;
@@ -434,10 +493,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
434
493
  hasEscrow: z.ZodOptional<z.ZodBoolean>;
435
494
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
436
495
  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
496
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
440
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
441
497
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
442
498
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
443
499
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -474,10 +530,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
474
530
  startAmount: number;
475
531
  endAmount: number;
476
532
  }>, "many">>;
533
+ warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
534
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
535
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
536
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
537
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
538
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
539
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
540
+ showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
477
541
  }, "strip", z.ZodTypeAny, {
478
542
  accountId: string;
479
543
  template: AssetTemplateType;
480
544
  platformSettings: string | null;
545
+ warrantsEnabled: boolean;
481
546
  assetName: string;
482
547
  assetType: AssetType;
483
548
  pricePerUnit: number | null;
@@ -505,15 +570,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
505
570
  hasEscrow?: boolean | undefined;
506
571
  bankAccountId?: string | null | undefined;
507
572
  escrowAccountId?: string | null | undefined;
573
+ totalShares?: number | null | undefined;
574
+ warrantTermYears?: number | null | undefined;
575
+ exercisePrice?: number | null | undefined;
576
+ warrantPercentage?: number | null | undefined;
577
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
578
+ incrementThreshold?: number | null | undefined;
579
+ shareClassId?: string | null | undefined;
508
580
  yield?: number | null | undefined;
509
581
  duration?: number | null | undefined;
510
582
  durationType?: DurationType | null | undefined;
511
583
  tiers?: number[] | null | undefined;
512
584
  enableBonus?: boolean | undefined;
513
- principalAmount?: number | null | undefined;
514
- maxTotalRaise?: number | null | undefined;
515
585
  interestRate?: number | null | undefined;
516
- interestType?: InterestType | null | undefined;
517
586
  bonusTiers?: {
518
587
  value: number;
519
588
  type: import("./bonus-tier.types").BonusType;
@@ -559,15 +628,20 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
559
628
  hasEscrow?: boolean | undefined;
560
629
  bankAccountId?: string | null | undefined;
561
630
  escrowAccountId?: string | null | undefined;
631
+ warrantsEnabled?: boolean | undefined;
632
+ totalShares?: number | null | undefined;
633
+ warrantTermYears?: number | null | undefined;
634
+ exercisePrice?: number | null | undefined;
635
+ warrantPercentage?: number | null | undefined;
636
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
637
+ incrementThreshold?: number | null | undefined;
638
+ shareClassId?: string | null | undefined;
562
639
  yield?: number | null | undefined;
563
640
  duration?: number | null | undefined;
564
641
  durationType?: DurationType | null | undefined;
565
642
  tiers?: number[] | null | undefined;
566
643
  enableBonus?: boolean | undefined;
567
- principalAmount?: number | null | undefined;
568
- maxTotalRaise?: number | null | undefined;
569
644
  interestRate?: number | null | undefined;
570
- interestType?: InterestType | null | undefined;
571
645
  bonusTiers?: {
572
646
  value: number;
573
647
  type: import("./bonus-tier.types").BonusType;
@@ -581,6 +655,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
581
655
  accountId: string;
582
656
  template: AssetTemplateType;
583
657
  platformSettings: string | null;
658
+ warrantsEnabled: boolean;
584
659
  assetName: string;
585
660
  assetType: AssetType;
586
661
  pricePerUnit: number | null;
@@ -608,15 +683,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
608
683
  hasEscrow?: boolean | undefined;
609
684
  bankAccountId?: string | null | undefined;
610
685
  escrowAccountId?: string | null | undefined;
686
+ totalShares?: number | null | undefined;
687
+ warrantTermYears?: number | null | undefined;
688
+ exercisePrice?: number | null | undefined;
689
+ warrantPercentage?: number | null | undefined;
690
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
691
+ incrementThreshold?: number | null | undefined;
692
+ shareClassId?: string | null | undefined;
611
693
  yield?: number | null | undefined;
612
694
  duration?: number | null | undefined;
613
695
  durationType?: DurationType | null | undefined;
614
696
  tiers?: number[] | null | undefined;
615
697
  enableBonus?: boolean | undefined;
616
- principalAmount?: number | null | undefined;
617
- maxTotalRaise?: number | null | undefined;
618
698
  interestRate?: number | null | undefined;
619
- interestType?: InterestType | null | undefined;
620
699
  bonusTiers?: {
621
700
  value: number;
622
701
  type: import("./bonus-tier.types").BonusType;
@@ -662,15 +741,20 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
662
741
  hasEscrow?: boolean | undefined;
663
742
  bankAccountId?: string | null | undefined;
664
743
  escrowAccountId?: string | null | undefined;
744
+ warrantsEnabled?: boolean | undefined;
745
+ totalShares?: number | null | undefined;
746
+ warrantTermYears?: number | null | undefined;
747
+ exercisePrice?: number | null | undefined;
748
+ warrantPercentage?: number | null | undefined;
749
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
750
+ incrementThreshold?: number | null | undefined;
751
+ shareClassId?: string | null | undefined;
665
752
  yield?: number | null | undefined;
666
753
  duration?: number | null | undefined;
667
754
  durationType?: DurationType | null | undefined;
668
755
  tiers?: number[] | null | undefined;
669
756
  enableBonus?: boolean | undefined;
670
- principalAmount?: number | null | undefined;
671
- maxTotalRaise?: number | null | undefined;
672
757
  interestRate?: number | null | undefined;
673
- interestType?: InterestType | null | undefined;
674
758
  bonusTiers?: {
675
759
  value: number;
676
760
  type: import("./bonus-tier.types").BonusType;
@@ -682,7 +766,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
682
766
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
683
767
  }>;
684
768
  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"]>;
769
+ export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount", "shareClass"]>;
686
770
  /**
687
771
  * @description Query parameters for including related entities
688
772
  * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
@@ -697,23 +781,27 @@ export declare const OfferingsIncludeQuery: z.ZodObject<{
697
781
  export interface OfferingsIncludeQuery extends z.infer<typeof OfferingsIncludeQuery> {
698
782
  }
699
783
  /**
700
- * @description
701
- * Filters for querying offerings.
784
+ * Filters supported for querying offerings.
702
785
  *
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
786
+ * Available fields:
787
+ * - `issuerName`: (string, optional) Filter by name of the issuer.
788
+ * - `name`: (string, optional) Filter by offering name.
789
+ * - `accountId`: (AccountId, optional) Filter by tenant/account ID.
790
+ * - `issuerId`: (IssuerId, optional) Filter by issuer ID.
791
+ * - `type`: (OfferingType, optional) Filter by offering type.
792
+ * - `status`: (ComplianceReview, optional) Filter by compliance review status.
793
+ * - `enabled`: (boolean, optional) Filter for enabled/active offerings.
794
+ * - `managedBy`: (ManagedByType, optional) Filter by which system or user manages the offering.
795
+ * - `versioningType`: (OfferingVersioningType, optional) Filter by versioning strategy.
796
+ * - `onboardingStatus`: (OfferingOnboardingStatus, optional) Filter by issuer onboarding status.
707
797
  *
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"
798
+ * @remarks
799
+ * These filters can be combined to query offerings across multiple dimensions.
714
800
  *
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.
801
+ * Example use:
802
+ * ```ts
803
+ * { issuerName: "ABC Capital", type: OfferingType.REG_A }
804
+ * ```
717
805
  */
718
806
  export declare const OfferingFiltersZod: z.ZodObject<{
719
807
  issuerName: z.ZodOptional<z.ZodString>;
@@ -725,32 +813,32 @@ export declare const OfferingFiltersZod: z.ZodObject<{
725
813
  enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
726
814
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
727
815
  versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
728
- combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
729
816
  onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingOnboardingStatus>>;
817
+ complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
730
818
  }, "strip", z.ZodTypeAny, {
731
819
  type?: OfferingType | undefined;
732
820
  status?: ComplianceReview | undefined;
733
821
  accountId?: string | undefined;
734
822
  name?: string | undefined;
735
823
  managedBy?: ManagedByType | undefined;
824
+ complianceReview?: ComplianceReview | undefined;
736
825
  onboardingStatus?: OfferingOnboardingStatus | undefined;
737
826
  enabled?: boolean | undefined;
738
827
  issuerId?: string | undefined;
739
828
  issuerName?: string | undefined;
740
829
  versioningType?: OfferingVersioningType | undefined;
741
- combinedStatus?: OfferingStatus | undefined;
742
830
  }, {
743
831
  type?: OfferingType | undefined;
744
832
  status?: ComplianceReview | undefined;
745
833
  accountId?: string | undefined;
746
834
  name?: string | undefined;
747
835
  managedBy?: ManagedByType | undefined;
836
+ complianceReview?: ComplianceReview | undefined;
748
837
  onboardingStatus?: OfferingOnboardingStatus | undefined;
749
838
  enabled?: unknown;
750
839
  issuerId?: string | undefined;
751
840
  issuerName?: string | undefined;
752
841
  versioningType?: OfferingVersioningType | undefined;
753
- combinedStatus?: OfferingStatus | undefined;
754
842
  }>;
755
843
  export type OfferingFiltersZod = z.infer<typeof OfferingFiltersZod>;
756
844
  export declare const OfferingSortZod: z.ZodObject<{
@@ -1220,6 +1308,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1220
1308
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
1221
1309
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
1222
1310
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
1311
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1223
1312
  } & {
1224
1313
  assetName: z.ZodOptional<z.ZodString>;
1225
1314
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -1231,10 +1320,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1231
1320
  template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
1232
1321
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
1233
1322
  enableBonus: z.ZodOptional<z.ZodBoolean>;
1234
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1235
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1236
1323
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1237
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
1238
1324
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
1239
1325
  type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
1240
1326
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -1275,6 +1361,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1275
1361
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1276
1362
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1277
1363
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1364
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
1365
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1366
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1367
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1368
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1369
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
1370
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1278
1371
  }, "strip", z.ZodTypeAny, {
1279
1372
  platformSettings: string | null;
1280
1373
  type?: OfferingType | undefined;
@@ -1302,6 +1395,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1302
1395
  escrowAgreementFileId?: string | null | undefined;
1303
1396
  bankAccountId?: string | null | undefined;
1304
1397
  escrowAccountId?: string | null | undefined;
1398
+ warrantsEnabled?: boolean | undefined;
1399
+ totalShares?: number | null | undefined;
1400
+ warrantTermYears?: number | null | undefined;
1401
+ exercisePrice?: number | null | undefined;
1402
+ warrantPercentage?: number | null | undefined;
1403
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1404
+ incrementThreshold?: number | null | undefined;
1405
+ shareClassId?: string | null | undefined;
1305
1406
  assetName?: string | undefined;
1306
1407
  assetType?: AssetType | undefined;
1307
1408
  pricePerUnit?: number | null | undefined;
@@ -1311,10 +1412,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1311
1412
  durationType?: DurationType | null | undefined;
1312
1413
  tiers?: number[] | null | undefined;
1313
1414
  enableBonus?: boolean | undefined;
1314
- principalAmount?: number | null | undefined;
1315
- maxTotalRaise?: number | null | undefined;
1316
1415
  interestRate?: number | null | undefined;
1317
- interestType?: InterestType | null | undefined;
1318
1416
  bonusTiers?: {
1319
1417
  value: number;
1320
1418
  type: import("./bonus-tier.types").BonusType;
@@ -1356,6 +1454,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1356
1454
  escrowAgreementFileId?: string | null | undefined;
1357
1455
  bankAccountId?: string | null | undefined;
1358
1456
  escrowAccountId?: string | null | undefined;
1457
+ warrantsEnabled?: boolean | undefined;
1458
+ totalShares?: number | null | undefined;
1459
+ warrantTermYears?: number | null | undefined;
1460
+ exercisePrice?: number | null | undefined;
1461
+ warrantPercentage?: number | null | undefined;
1462
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1463
+ incrementThreshold?: number | null | undefined;
1464
+ shareClassId?: string | null | undefined;
1359
1465
  assetName?: string | undefined;
1360
1466
  assetType?: AssetType | undefined;
1361
1467
  pricePerUnit?: number | null | undefined;
@@ -1365,10 +1471,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1365
1471
  durationType?: DurationType | null | undefined;
1366
1472
  tiers?: number[] | null | undefined;
1367
1473
  enableBonus?: boolean | undefined;
1368
- principalAmount?: number | null | undefined;
1369
- maxTotalRaise?: number | null | undefined;
1370
1474
  interestRate?: number | null | undefined;
1371
- interestType?: InterestType | null | undefined;
1372
1475
  bonusTiers?: {
1373
1476
  value: number;
1374
1477
  type: import("./bonus-tier.types").BonusType;
@@ -1636,6 +1739,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1636
1739
  escrowAgreementFileId?: string | null | undefined;
1637
1740
  bankAccountId?: string | null | undefined;
1638
1741
  escrowAccountId?: string | null | undefined;
1742
+ warrantsEnabled?: boolean | undefined;
1743
+ totalShares?: number | null | undefined;
1744
+ warrantTermYears?: number | null | undefined;
1745
+ exercisePrice?: number | null | undefined;
1746
+ warrantPercentage?: number | null | undefined;
1747
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1748
+ incrementThreshold?: number | null | undefined;
1749
+ shareClassId?: string | null | undefined;
1639
1750
  assetName?: string | undefined;
1640
1751
  assetType?: AssetType | undefined;
1641
1752
  pricePerUnit?: number | null | undefined;
@@ -1645,10 +1756,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1645
1756
  durationType?: DurationType | null | undefined;
1646
1757
  tiers?: number[] | null | undefined;
1647
1758
  enableBonus?: boolean | undefined;
1648
- principalAmount?: number | null | undefined;
1649
- maxTotalRaise?: number | null | undefined;
1650
1759
  interestRate?: number | null | undefined;
1651
- interestType?: InterestType | null | undefined;
1652
1760
  bonusTiers?: {
1653
1761
  value: number;
1654
1762
  type: import("./bonus-tier.types").BonusType;
@@ -1701,6 +1809,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1701
1809
  escrowAgreementFileId?: string | null | undefined;
1702
1810
  bankAccountId?: string | null | undefined;
1703
1811
  escrowAccountId?: string | null | undefined;
1812
+ warrantsEnabled?: boolean | undefined;
1813
+ totalShares?: number | null | undefined;
1814
+ warrantTermYears?: number | null | undefined;
1815
+ exercisePrice?: number | null | undefined;
1816
+ warrantPercentage?: number | null | undefined;
1817
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1818
+ incrementThreshold?: number | null | undefined;
1819
+ shareClassId?: string | null | undefined;
1704
1820
  assetName?: string | undefined;
1705
1821
  assetType?: AssetType | undefined;
1706
1822
  pricePerUnit?: number | null | undefined;
@@ -1710,10 +1826,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1710
1826
  durationType?: DurationType | null | undefined;
1711
1827
  tiers?: number[] | null | undefined;
1712
1828
  enableBonus?: boolean | undefined;
1713
- principalAmount?: number | null | undefined;
1714
- maxTotalRaise?: number | null | undefined;
1715
1829
  interestRate?: number | null | undefined;
1716
- interestType?: InterestType | null | undefined;
1717
1830
  bonusTiers?: {
1718
1831
  value: number;
1719
1832
  type: import("./bonus-tier.types").BonusType;
@@ -2457,6 +2570,7 @@ export type OfferingUpdateFields = {
2457
2570
  managedBy?: ManagedByType | null;
2458
2571
  showTotalRaised?: boolean;
2459
2572
  enabled?: boolean;
2573
+ shareClassId?: string | null;
2460
2574
  };
2461
2575
  export declare const ReviewOfferingOnboarding: z.ZodObject<{
2462
2576
  onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
@@ -2652,3 +2766,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
2652
2766
  currentEscrowAgreementFileId: string | null;
2653
2767
  }>;
2654
2768
  export type EscrowValidationContext = z.infer<typeof EscrowValidationContextZod>;
2769
+ /**
2770
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
2771
+ */
2772
+ export declare const WarrantSharesBaseZod: z.ZodObject<{
2773
+ warrantsEnabled: z.ZodBoolean;
2774
+ totalShares: z.ZodNullable<z.ZodNumber>;
2775
+ warrantTermYears: z.ZodNullable<z.ZodNumber>;
2776
+ exercisePrice: z.ZodNullable<z.ZodNumber>;
2777
+ warrantPercentage: z.ZodNullable<z.ZodNumber>;
2778
+ calculationMethod: z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>;
2779
+ incrementThreshold: z.ZodNullable<z.ZodNumber>;
2780
+ fullyDilutedShares: z.ZodNullable<z.ZodNumber>;
2781
+ }, "strip", z.ZodTypeAny, {
2782
+ warrantsEnabled: boolean;
2783
+ totalShares: number | null;
2784
+ warrantTermYears: number | null;
2785
+ exercisePrice: number | null;
2786
+ warrantPercentage: number | null;
2787
+ calculationMethod: WarrantSharesCalculationMethod | null;
2788
+ incrementThreshold: number | null;
2789
+ fullyDilutedShares: number | null;
2790
+ }, {
2791
+ warrantsEnabled: boolean;
2792
+ totalShares: number | null;
2793
+ warrantTermYears: number | null;
2794
+ exercisePrice: number | null;
2795
+ warrantPercentage: number | null;
2796
+ calculationMethod: WarrantSharesCalculationMethod | null;
2797
+ incrementThreshold: number | null;
2798
+ fullyDilutedShares: number | null;
2799
+ }>;
2800
+ export type WarrantSharesBase = z.infer<typeof WarrantSharesBaseZod>;
2801
+ /**
2802
+ * All warrant field keys used when picking warrant data from base or patch.
2803
+ */
2804
+ export declare const WARRANT_FIELD_KEYS: (keyof WarrantSharesBase)[];
2805
+ /**
2806
+ * Warrant field keys required when enabling warrants (turning warrants on).
2807
+ */
2808
+ export declare const WARRANT_REQUIRED_WHEN_ENABLED_KEYS: (keyof WarrantSharesBase)[];
2809
+ /**
2810
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
2811
+ */
2812
+ export declare const WarrantValidationDataZod: z.ZodObject<{
2813
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
2814
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2815
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2816
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2817
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2818
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
2819
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2820
+ fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2821
+ }, "strip", z.ZodTypeAny, {
2822
+ warrantsEnabled?: boolean | undefined;
2823
+ totalShares?: number | null | undefined;
2824
+ warrantTermYears?: number | null | undefined;
2825
+ exercisePrice?: number | null | undefined;
2826
+ warrantPercentage?: number | null | undefined;
2827
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2828
+ incrementThreshold?: number | null | undefined;
2829
+ fullyDilutedShares?: number | null | undefined;
2830
+ }, {
2831
+ warrantsEnabled?: boolean | undefined;
2832
+ totalShares?: number | null | undefined;
2833
+ warrantTermYears?: number | null | undefined;
2834
+ exercisePrice?: number | null | undefined;
2835
+ warrantPercentage?: number | null | undefined;
2836
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2837
+ incrementThreshold?: number | null | undefined;
2838
+ fullyDilutedShares?: number | null | undefined;
2839
+ }>;
2840
+ export type WarrantValidationData = z.infer<typeof WarrantValidationDataZod>;
2841
+ /**
2842
+ * Validated warrant payload to persist on revision and offering.
2843
+ */
2844
+ export type WarrantValidationResult = WarrantSharesBase;
2845
+ /**
2846
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
2847
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
2848
+ */
2849
+ export declare const WARRANT_DISABLED_FIELD_RESETS: WarrantValidationResult;