@dalmore/api-contracts 0.0.0-dev.d38f1ff → 0.0.0-dev.d4be84e

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 (95) hide show
  1. package/common/constants.d.ts +28 -0
  2. package/common/constants.js +62 -0
  3. package/common/constants.js.map +1 -0
  4. package/common/helpers/index.d.ts +8 -0
  5. package/common/helpers/index.js +15 -0
  6. package/common/helpers/index.js.map +1 -1
  7. package/common/types/account-setting.types.d.ts +22 -66
  8. package/common/types/account-setting.types.js +2 -31
  9. package/common/types/account-setting.types.js.map +1 -1
  10. package/common/types/account.types.d.ts +32 -23
  11. package/common/types/account.types.js +1 -0
  12. package/common/types/account.types.js.map +1 -1
  13. package/common/types/activity.types.d.ts +8 -1
  14. package/common/types/activity.types.js +7 -0
  15. package/common/types/activity.types.js.map +1 -1
  16. package/common/types/auth.types.d.ts +36 -0
  17. package/common/types/auth.types.js +3 -2
  18. package/common/types/auth.types.js.map +1 -1
  19. package/common/types/cap-table.types.d.ts +177 -53
  20. package/common/types/cap-table.types.js +31 -0
  21. package/common/types/cap-table.types.js.map +1 -1
  22. package/common/types/common.types.d.ts +334 -4
  23. package/common/types/common.types.js +55 -1
  24. package/common/types/common.types.js.map +1 -1
  25. package/common/types/csv.types.d.ts +1730 -0
  26. package/common/types/csv.types.js +178 -0
  27. package/common/types/csv.types.js.map +1 -0
  28. package/common/types/disbursement-transaction.types.d.ts +1 -1
  29. package/common/types/disbursement-transaction.types.js +1 -1
  30. package/common/types/disbursement-transaction.types.js.map +1 -1
  31. package/common/types/disbursements.types.d.ts +939 -7
  32. package/common/types/disbursements.types.js +92 -2
  33. package/common/types/disbursements.types.js.map +1 -1
  34. package/common/types/exchange-provider.types.d.ts +12 -12
  35. package/common/types/file.types.d.ts +24 -0
  36. package/common/types/file.types.js +12 -0
  37. package/common/types/file.types.js.map +1 -1
  38. package/common/types/index.d.ts +3 -0
  39. package/common/types/index.js +3 -0
  40. package/common/types/index.js.map +1 -1
  41. package/common/types/individuals.types.d.ts +207 -5
  42. package/common/types/individuals.types.js +11 -14
  43. package/common/types/individuals.types.js.map +1 -1
  44. package/common/types/investor-account.types.d.ts +1 -1
  45. package/common/types/investor-account.types.js +1 -2
  46. package/common/types/investor-account.types.js.map +1 -1
  47. package/common/types/investors-offering.types.d.ts +8 -0
  48. package/common/types/investors-offering.types.js +1 -0
  49. package/common/types/investors-offering.types.js.map +1 -1
  50. package/common/types/invite.types.d.ts +2 -2
  51. package/common/types/invite.types.js +1 -1
  52. package/common/types/invite.types.js.map +1 -1
  53. package/common/types/issuer-offering.types.d.ts +183 -12
  54. package/common/types/issuer-offering.types.js +204 -36
  55. package/common/types/issuer-offering.types.js.map +1 -1
  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/offering-submission.types.d.ts +198 -0
  60. package/common/types/offering-submission.types.js +14 -1
  61. package/common/types/offering-submission.types.js.map +1 -1
  62. package/common/types/offering.types.d.ts +269 -25
  63. package/common/types/offering.types.js +247 -22
  64. package/common/types/offering.types.js.map +1 -1
  65. package/common/types/portfolio.types.d.ts +6 -6
  66. package/common/types/review.types.js +1 -1
  67. package/common/types/review.types.js.map +1 -1
  68. package/common/types/secondary-order.types.d.ts +10 -10
  69. package/common/types/secondary-trade.types.d.ts +10 -10
  70. package/common/types/site.types.d.ts +12 -12
  71. package/common/types/trade-line-item.types.d.ts +24 -0
  72. package/common/types/trade-line-item.types.js +3 -0
  73. package/common/types/trade-line-item.types.js.map +1 -1
  74. package/common/types/trade.types.d.ts +10 -0
  75. package/common/types/trade.types.js +17 -1
  76. package/common/types/trade.types.js.map +1 -1
  77. package/common/types/transaction.types.d.ts +0 -1
  78. package/common/types/transaction.types.js +0 -1
  79. package/common/types/transaction.types.js.map +1 -1
  80. package/common/types/user.types.d.ts +76 -82
  81. package/common/types/user.types.js +3 -23
  82. package/common/types/user.types.js.map +1 -1
  83. package/contracts/clients/csv/index.d.ts +1733 -0
  84. package/contracts/clients/csv/index.js +79 -0
  85. package/contracts/clients/csv/index.js.map +1 -0
  86. package/contracts/clients/index.d.ts +1913 -11
  87. package/contracts/clients/index.js +4 -0
  88. package/contracts/clients/index.js.map +1 -1
  89. package/contracts/clients/individuals/index.d.ts +5 -5
  90. package/contracts/clients/legal-entities/index.d.ts +1 -1
  91. package/contracts/clients/offerings/index.d.ts +90 -5
  92. package/contracts/clients/review/index.d.ts +85 -0
  93. package/contracts/clients/review/index.js +27 -0
  94. package/contracts/clients/review/index.js.map +1 -0
  95. package/package.json +1 -1
@@ -1,6 +1,5 @@
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';
2
+ import { ComplianceReview, OfferingType, ManagedByType, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, WarrantSharesCalculationMethod } from './common.types';
4
3
  import { AssetTemplateType } from './asset.types';
5
4
  export declare enum OfferingFeeType {
6
5
  FIXED = "FIXED",
@@ -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<{
@@ -68,9 +75,11 @@ export declare const IPaginatedOffering: z.ZodObject<{
68
75
  };
69
76
  }>;
70
77
  export type IPaginatedOffering = z.infer<typeof IPaginatedOffering>;
78
+ export declare const OfferingDescriptionZod: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>;
79
+ export type OfferingDescriptionZod = z.infer<typeof OfferingDescriptionZod>;
71
80
  export declare const PatchOfferingBase: z.ZodObject<{
72
81
  name: z.ZodOptional<z.ZodString>;
73
- description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
82
+ description: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>;
74
83
  tid: z.ZodOptional<z.ZodString>;
75
84
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
76
85
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -113,6 +122,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
113
122
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
114
123
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
115
124
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
125
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
116
126
  }, "strip", z.ZodTypeAny, {
117
127
  platformSettings: string | null;
118
128
  type?: OfferingType | undefined;
@@ -135,6 +145,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
135
145
  memorandumId?: string | null | undefined;
136
146
  subscriptionAgreementId?: string | null | undefined;
137
147
  showTotalRaised?: boolean | undefined;
148
+ shareClassId?: string | null | undefined;
138
149
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
139
150
  subscriptionAgreementTemplateId?: string | null | undefined;
140
151
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -165,13 +176,14 @@ export declare const PatchOfferingBase: z.ZodObject<{
165
176
  memorandumId?: string | null | undefined;
166
177
  subscriptionAgreementId?: string | null | undefined;
167
178
  showTotalRaised?: boolean | undefined;
179
+ shareClassId?: string | null | undefined;
168
180
  entitySubscriptionAgreementTemplateId?: string | null | undefined;
169
181
  subscriptionAgreementTemplateId?: string | null | undefined;
170
182
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
171
183
  }>;
172
184
  export declare const PatchOffering: z.ZodObject<{
173
185
  name: z.ZodOptional<z.ZodString>;
174
- description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
186
+ description: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>;
175
187
  tid: z.ZodOptional<z.ZodString>;
176
188
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
177
189
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -214,6 +226,7 @@ export declare const PatchOffering: z.ZodObject<{
214
226
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
215
227
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
216
228
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
229
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
217
230
  } & {
218
231
  assetName: z.ZodOptional<z.ZodString>;
219
232
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -266,6 +279,13 @@ export declare const PatchOffering: z.ZodObject<{
266
279
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
267
280
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
268
281
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
282
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
283
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
284
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
285
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
286
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
287
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
288
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
269
289
  }, "strip", z.ZodTypeAny, {
270
290
  platformSettings: string | null;
271
291
  type?: OfferingType | undefined;
@@ -293,6 +313,14 @@ export declare const PatchOffering: z.ZodObject<{
293
313
  escrowAgreementFileId?: string | null | undefined;
294
314
  bankAccountId?: string | null | undefined;
295
315
  escrowAccountId?: string | null | undefined;
316
+ warrantsEnabled?: boolean | undefined;
317
+ totalShares?: number | null | undefined;
318
+ warrantTermYears?: number | null | undefined;
319
+ exercisePrice?: number | null | undefined;
320
+ warrantPercentage?: number | null | undefined;
321
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
322
+ incrementThreshold?: number | null | undefined;
323
+ shareClassId?: string | null | undefined;
296
324
  assetName?: string | undefined;
297
325
  assetType?: AssetType | undefined;
298
326
  pricePerUnit?: number | null | undefined;
@@ -344,6 +372,14 @@ export declare const PatchOffering: z.ZodObject<{
344
372
  escrowAgreementFileId?: string | null | undefined;
345
373
  bankAccountId?: string | null | undefined;
346
374
  escrowAccountId?: string | null | undefined;
375
+ warrantsEnabled?: boolean | undefined;
376
+ totalShares?: number | null | undefined;
377
+ warrantTermYears?: number | null | undefined;
378
+ exercisePrice?: number | null | undefined;
379
+ warrantPercentage?: number | null | undefined;
380
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
381
+ incrementThreshold?: number | null | undefined;
382
+ shareClassId?: string | null | undefined;
347
383
  assetName?: string | undefined;
348
384
  assetType?: AssetType | undefined;
349
385
  pricePerUnit?: number | null | undefined;
@@ -365,9 +401,51 @@ export declare const PatchOffering: z.ZodObject<{
365
401
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
366
402
  }>;
367
403
  export type PatchOffering = z.infer<typeof PatchOffering>;
404
+ /**
405
+ * Optional params for resolveAndValidateOfferingUpdateFields.
406
+ * All fields are optional and nullable; resolution merges with offering/asset values.
407
+ */
408
+ export declare const ResolveOfferingUpdateFieldsParamsZod: z.ZodObject<{
409
+ minInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
410
+ maxInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
411
+ targetAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
412
+ pricePerUnit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
413
+ }, "strip", z.ZodTypeAny, {
414
+ targetAmount?: number | null | undefined;
415
+ minInvestment?: number | null | undefined;
416
+ maxInvestment?: number | null | undefined;
417
+ pricePerUnit?: number | null | undefined;
418
+ }, {
419
+ targetAmount?: number | null | undefined;
420
+ minInvestment?: number | null | undefined;
421
+ maxInvestment?: number | null | undefined;
422
+ pricePerUnit?: number | null | undefined;
423
+ }>;
424
+ export type ResolveOfferingUpdateFieldsParams = z.infer<typeof ResolveOfferingUpdateFieldsParamsZod>;
425
+ /**
426
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
427
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
428
+ */
429
+ export declare const ResolvedOfferingUpdateFieldsZod: z.ZodObject<{
430
+ pricePerUnit: z.ZodNumber;
431
+ targetAmount: z.ZodNumber;
432
+ minInvestment: z.ZodNullable<z.ZodNumber>;
433
+ maxInvestment: z.ZodNullable<z.ZodNumber>;
434
+ }, "strip", z.ZodTypeAny, {
435
+ targetAmount: number;
436
+ minInvestment: number | null;
437
+ maxInvestment: number | null;
438
+ pricePerUnit: number;
439
+ }, {
440
+ targetAmount: number;
441
+ minInvestment: number | null;
442
+ maxInvestment: number | null;
443
+ pricePerUnit: number;
444
+ }>;
445
+ export type ResolvedOfferingUpdateFields = z.infer<typeof ResolvedOfferingUpdateFieldsZod>;
368
446
  export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
369
447
  name: z.ZodOptional<z.ZodString>;
370
- description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
448
+ description: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>;
371
449
  tid: z.ZodOptional<z.ZodString>;
372
450
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
373
451
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -407,11 +485,11 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
407
485
  subscriptionAgreementId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
408
486
  jointSubscriptionAgreementTemplateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
409
487
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
410
- showTotalRaised: z.ZodOptional<z.ZodBoolean>;
411
488
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
412
489
  } & {
413
490
  accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
414
491
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
492
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
415
493
  assetName: z.ZodString;
416
494
  assetType: z.ZodNativeEnum<typeof AssetType>;
417
495
  pricePerUnit: z.ZodNullable<z.ZodNumber>;
@@ -462,10 +540,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
462
540
  startAmount: number;
463
541
  endAmount: number;
464
542
  }>, "many">>;
543
+ warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
544
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
545
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
546
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
547
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
548
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
549
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
550
+ showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
465
551
  }, "strip", z.ZodTypeAny, {
466
552
  accountId: string;
467
553
  template: AssetTemplateType;
468
554
  platformSettings: string | null;
555
+ warrantsEnabled: boolean;
469
556
  assetName: string;
470
557
  assetType: AssetType;
471
558
  pricePerUnit: number | null;
@@ -493,6 +580,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
493
580
  hasEscrow?: boolean | undefined;
494
581
  bankAccountId?: string | null | undefined;
495
582
  escrowAccountId?: string | null | undefined;
583
+ totalShares?: number | null | undefined;
584
+ warrantTermYears?: number | null | undefined;
585
+ exercisePrice?: number | null | undefined;
586
+ warrantPercentage?: number | null | undefined;
587
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
588
+ incrementThreshold?: number | null | undefined;
589
+ shareClassId?: string | null | undefined;
496
590
  yield?: number | null | undefined;
497
591
  duration?: number | null | undefined;
498
592
  durationType?: DurationType | null | undefined;
@@ -544,6 +638,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
544
638
  hasEscrow?: boolean | undefined;
545
639
  bankAccountId?: string | null | undefined;
546
640
  escrowAccountId?: string | null | undefined;
641
+ warrantsEnabled?: boolean | undefined;
642
+ totalShares?: number | null | undefined;
643
+ warrantTermYears?: number | null | undefined;
644
+ exercisePrice?: number | null | undefined;
645
+ warrantPercentage?: number | null | undefined;
646
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
647
+ incrementThreshold?: number | null | undefined;
648
+ shareClassId?: string | null | undefined;
547
649
  yield?: number | null | undefined;
548
650
  duration?: number | null | undefined;
549
651
  durationType?: DurationType | null | undefined;
@@ -563,6 +665,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
563
665
  accountId: string;
564
666
  template: AssetTemplateType;
565
667
  platformSettings: string | null;
668
+ warrantsEnabled: boolean;
566
669
  assetName: string;
567
670
  assetType: AssetType;
568
671
  pricePerUnit: number | null;
@@ -590,6 +693,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
590
693
  hasEscrow?: boolean | undefined;
591
694
  bankAccountId?: string | null | undefined;
592
695
  escrowAccountId?: string | null | undefined;
696
+ totalShares?: number | null | undefined;
697
+ warrantTermYears?: number | null | undefined;
698
+ exercisePrice?: number | null | undefined;
699
+ warrantPercentage?: number | null | undefined;
700
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
701
+ incrementThreshold?: number | null | undefined;
702
+ shareClassId?: string | null | undefined;
593
703
  yield?: number | null | undefined;
594
704
  duration?: number | null | undefined;
595
705
  durationType?: DurationType | null | undefined;
@@ -641,6 +751,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
641
751
  hasEscrow?: boolean | undefined;
642
752
  bankAccountId?: string | null | undefined;
643
753
  escrowAccountId?: string | null | undefined;
754
+ warrantsEnabled?: boolean | undefined;
755
+ totalShares?: number | null | undefined;
756
+ warrantTermYears?: number | null | undefined;
757
+ exercisePrice?: number | null | undefined;
758
+ warrantPercentage?: number | null | undefined;
759
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
760
+ incrementThreshold?: number | null | undefined;
761
+ shareClassId?: string | null | undefined;
644
762
  yield?: number | null | undefined;
645
763
  duration?: number | null | undefined;
646
764
  durationType?: DurationType | null | undefined;
@@ -658,7 +776,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
658
776
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
659
777
  }>;
660
778
  export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
661
- export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount"]>;
779
+ export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount", "shareClass"]>;
662
780
  /**
663
781
  * @description Query parameters for including related entities
664
782
  * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
@@ -673,23 +791,27 @@ export declare const OfferingsIncludeQuery: z.ZodObject<{
673
791
  export interface OfferingsIncludeQuery extends z.infer<typeof OfferingsIncludeQuery> {
674
792
  }
675
793
  /**
676
- * @description
677
- * Filters for querying offerings.
794
+ * Filters supported for querying offerings.
678
795
  *
679
- * The "combinedStatus" filter provides a unified status that combines three separate fields:
680
- * - complianceReview: The compliance review status of the offering
681
- * - onboardingStatus: The onboarding completion status
682
- * - enabled: Whether the offering is currently enabled/active
796
+ * Available fields:
797
+ * - `issuerName`: (string, optional) Filter by name of the issuer.
798
+ * - `name`: (string, optional) Filter by offering name.
799
+ * - `accountId`: (AccountId, optional) Filter by tenant/account ID.
800
+ * - `issuerId`: (IssuerId, optional) Filter by issuer ID.
801
+ * - `type`: (OfferingType, optional) Filter by offering type.
802
+ * - `status`: (ComplianceReview, optional) Filter by compliance review status.
803
+ * - `enabled`: (boolean, optional) Filter for enabled/active offerings.
804
+ * - `managedBy`: (ManagedByType, optional) Filter by which system or user manages the offering.
805
+ * - `versioningType`: (OfferingVersioningType, optional) Filter by versioning strategy.
806
+ * - `onboardingStatus`: (OfferingOnboardingStatus, optional) Filter by issuer onboarding status.
683
807
  *
684
- * The combinedStatus is calculated using the following priority rules:
685
- * 1. If onboardingStatus is "IN_REVIEW" combinedStatus = "ONBOARDING"
686
- * 2. Else if complianceReview is not "APPROVED" → combinedStatus = "IN_COMPLIANCE_REVIEW"
687
- * 3. Else if onboardingStatus is "COMPLETE" and complianceReview is "APPROVED" →
688
- * - If enabled is true → combinedStatus = "ACTIVE"
689
- * - If enabled is false → combinedStatus = "PAUSED"
808
+ * @remarks
809
+ * These filters can be combined to query offerings across multiple dimensions.
690
810
  *
691
- * This allows for filtering offerings by a single summary state that reflects the overall user-facing status,
692
- * rather than requiring separate filters for each individual field.
811
+ * Example use:
812
+ * ```ts
813
+ * { issuerName: "ABC Capital", type: OfferingType.REG_A }
814
+ * ```
693
815
  */
694
816
  export declare const OfferingFiltersZod: z.ZodObject<{
695
817
  issuerName: z.ZodOptional<z.ZodString>;
@@ -701,32 +823,32 @@ export declare const OfferingFiltersZod: z.ZodObject<{
701
823
  enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
702
824
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
703
825
  versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
704
- combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
705
826
  onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingOnboardingStatus>>;
827
+ complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
706
828
  }, "strip", z.ZodTypeAny, {
707
829
  type?: OfferingType | undefined;
708
830
  status?: ComplianceReview | undefined;
709
831
  accountId?: string | undefined;
710
832
  name?: string | undefined;
711
833
  managedBy?: ManagedByType | undefined;
834
+ complianceReview?: ComplianceReview | undefined;
712
835
  onboardingStatus?: OfferingOnboardingStatus | undefined;
713
836
  enabled?: boolean | undefined;
714
837
  issuerId?: string | undefined;
715
838
  issuerName?: string | undefined;
716
839
  versioningType?: OfferingVersioningType | undefined;
717
- combinedStatus?: OfferingStatus | undefined;
718
840
  }, {
719
841
  type?: OfferingType | undefined;
720
842
  status?: ComplianceReview | undefined;
721
843
  accountId?: string | undefined;
722
844
  name?: string | undefined;
723
845
  managedBy?: ManagedByType | undefined;
846
+ complianceReview?: ComplianceReview | undefined;
724
847
  onboardingStatus?: OfferingOnboardingStatus | undefined;
725
848
  enabled?: unknown;
726
849
  issuerId?: string | undefined;
727
850
  issuerName?: string | undefined;
728
851
  versioningType?: OfferingVersioningType | undefined;
729
- combinedStatus?: OfferingStatus | undefined;
730
852
  }>;
731
853
  export type OfferingFiltersZod = z.infer<typeof OfferingFiltersZod>;
732
854
  export declare const OfferingSortZod: z.ZodObject<{
@@ -1153,7 +1275,7 @@ export declare const OfferingSettings: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.
1153
1275
  export type OfferingSettings = z.infer<typeof OfferingSettings>;
1154
1276
  export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.ZodObject<{
1155
1277
  name: z.ZodOptional<z.ZodString>;
1156
- description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1278
+ description: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>;
1157
1279
  tid: z.ZodOptional<z.ZodString>;
1158
1280
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
1159
1281
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -1196,6 +1318,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1196
1318
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
1197
1319
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
1198
1320
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
1321
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1199
1322
  } & {
1200
1323
  assetName: z.ZodOptional<z.ZodString>;
1201
1324
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -1248,6 +1371,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1248
1371
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1249
1372
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1250
1373
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1374
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
1375
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1376
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
1377
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1378
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1379
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
1380
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
1251
1381
  }, "strip", z.ZodTypeAny, {
1252
1382
  platformSettings: string | null;
1253
1383
  type?: OfferingType | undefined;
@@ -1275,6 +1405,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1275
1405
  escrowAgreementFileId?: string | null | undefined;
1276
1406
  bankAccountId?: string | null | undefined;
1277
1407
  escrowAccountId?: string | null | undefined;
1408
+ warrantsEnabled?: boolean | undefined;
1409
+ totalShares?: number | null | undefined;
1410
+ warrantTermYears?: number | null | undefined;
1411
+ exercisePrice?: number | null | undefined;
1412
+ warrantPercentage?: number | null | undefined;
1413
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1414
+ incrementThreshold?: number | null | undefined;
1415
+ shareClassId?: string | null | undefined;
1278
1416
  assetName?: string | undefined;
1279
1417
  assetType?: AssetType | undefined;
1280
1418
  pricePerUnit?: number | null | undefined;
@@ -1326,6 +1464,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1326
1464
  escrowAgreementFileId?: string | null | undefined;
1327
1465
  bankAccountId?: string | null | undefined;
1328
1466
  escrowAccountId?: string | null | undefined;
1467
+ warrantsEnabled?: boolean | undefined;
1468
+ totalShares?: number | null | undefined;
1469
+ warrantTermYears?: number | null | undefined;
1470
+ exercisePrice?: number | null | undefined;
1471
+ warrantPercentage?: number | null | undefined;
1472
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1473
+ incrementThreshold?: number | null | undefined;
1474
+ shareClassId?: string | null | undefined;
1329
1475
  assetName?: string | undefined;
1330
1476
  assetType?: AssetType | undefined;
1331
1477
  pricePerUnit?: number | null | undefined;
@@ -1603,6 +1749,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1603
1749
  escrowAgreementFileId?: string | null | undefined;
1604
1750
  bankAccountId?: string | null | undefined;
1605
1751
  escrowAccountId?: string | null | undefined;
1752
+ warrantsEnabled?: boolean | undefined;
1753
+ totalShares?: number | null | undefined;
1754
+ warrantTermYears?: number | null | undefined;
1755
+ exercisePrice?: number | null | undefined;
1756
+ warrantPercentage?: number | null | undefined;
1757
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1758
+ incrementThreshold?: number | null | undefined;
1759
+ shareClassId?: string | null | undefined;
1606
1760
  assetName?: string | undefined;
1607
1761
  assetType?: AssetType | undefined;
1608
1762
  pricePerUnit?: number | null | undefined;
@@ -1665,6 +1819,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1665
1819
  escrowAgreementFileId?: string | null | undefined;
1666
1820
  bankAccountId?: string | null | undefined;
1667
1821
  escrowAccountId?: string | null | undefined;
1822
+ warrantsEnabled?: boolean | undefined;
1823
+ totalShares?: number | null | undefined;
1824
+ warrantTermYears?: number | null | undefined;
1825
+ exercisePrice?: number | null | undefined;
1826
+ warrantPercentage?: number | null | undefined;
1827
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
1828
+ incrementThreshold?: number | null | undefined;
1829
+ shareClassId?: string | null | undefined;
1668
1830
  assetName?: string | undefined;
1669
1831
  assetType?: AssetType | undefined;
1670
1832
  pricePerUnit?: number | null | undefined;
@@ -2418,6 +2580,7 @@ export type OfferingUpdateFields = {
2418
2580
  managedBy?: ManagedByType | null;
2419
2581
  showTotalRaised?: boolean;
2420
2582
  enabled?: boolean;
2583
+ shareClassId?: string | null;
2421
2584
  };
2422
2585
  export declare const ReviewOfferingOnboarding: z.ZodObject<{
2423
2586
  onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
@@ -2613,3 +2776,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
2613
2776
  currentEscrowAgreementFileId: string | null;
2614
2777
  }>;
2615
2778
  export type EscrowValidationContext = z.infer<typeof EscrowValidationContextZod>;
2779
+ /**
2780
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
2781
+ */
2782
+ export declare const WarrantSharesBaseZod: z.ZodObject<{
2783
+ warrantsEnabled: z.ZodBoolean;
2784
+ totalShares: z.ZodNullable<z.ZodNumber>;
2785
+ warrantTermYears: z.ZodNullable<z.ZodNumber>;
2786
+ exercisePrice: z.ZodNullable<z.ZodNumber>;
2787
+ warrantPercentage: z.ZodNullable<z.ZodNumber>;
2788
+ calculationMethod: z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>;
2789
+ incrementThreshold: z.ZodNullable<z.ZodNumber>;
2790
+ fullyDilutedShares: z.ZodNullable<z.ZodNumber>;
2791
+ }, "strip", z.ZodTypeAny, {
2792
+ warrantsEnabled: boolean;
2793
+ totalShares: number | null;
2794
+ warrantTermYears: number | null;
2795
+ exercisePrice: number | null;
2796
+ warrantPercentage: number | null;
2797
+ calculationMethod: WarrantSharesCalculationMethod | null;
2798
+ incrementThreshold: number | null;
2799
+ fullyDilutedShares: number | null;
2800
+ }, {
2801
+ warrantsEnabled: boolean;
2802
+ totalShares: number | null;
2803
+ warrantTermYears: number | null;
2804
+ exercisePrice: number | null;
2805
+ warrantPercentage: number | null;
2806
+ calculationMethod: WarrantSharesCalculationMethod | null;
2807
+ incrementThreshold: number | null;
2808
+ fullyDilutedShares: number | null;
2809
+ }>;
2810
+ export type WarrantSharesBase = z.infer<typeof WarrantSharesBaseZod>;
2811
+ /**
2812
+ * All warrant field keys used when picking warrant data from base or patch.
2813
+ */
2814
+ export declare const WARRANT_FIELD_KEYS: (keyof WarrantSharesBase)[];
2815
+ /**
2816
+ * Warrant field keys required when enabling warrants (turning warrants on).
2817
+ */
2818
+ export declare const WARRANT_REQUIRED_WHEN_ENABLED_KEYS: (keyof WarrantSharesBase)[];
2819
+ /**
2820
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
2821
+ */
2822
+ export declare const WarrantValidationDataZod: z.ZodObject<{
2823
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
2824
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2825
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2826
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2827
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2828
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
2829
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2830
+ fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2831
+ }, "strip", z.ZodTypeAny, {
2832
+ warrantsEnabled?: boolean | undefined;
2833
+ totalShares?: number | null | undefined;
2834
+ warrantTermYears?: number | null | undefined;
2835
+ exercisePrice?: number | null | undefined;
2836
+ warrantPercentage?: number | null | undefined;
2837
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2838
+ incrementThreshold?: number | null | undefined;
2839
+ fullyDilutedShares?: number | null | undefined;
2840
+ }, {
2841
+ warrantsEnabled?: boolean | undefined;
2842
+ totalShares?: number | null | undefined;
2843
+ warrantTermYears?: number | null | undefined;
2844
+ exercisePrice?: number | null | undefined;
2845
+ warrantPercentage?: number | null | undefined;
2846
+ calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
2847
+ incrementThreshold?: number | null | undefined;
2848
+ fullyDilutedShares?: number | null | undefined;
2849
+ }>;
2850
+ export type WarrantValidationData = z.infer<typeof WarrantValidationDataZod>;
2851
+ /**
2852
+ * Validated warrant payload to persist on revision and offering.
2853
+ */
2854
+ export type WarrantValidationResult = WarrantSharesBase;
2855
+ /**
2856
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
2857
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
2858
+ */
2859
+ export declare const WARRANT_DISABLED_FIELD_RESETS: WarrantValidationResult;