@dalmore/api-contracts 0.0.0-dev.22a3970 → 0.0.0-dev.25fc9e2

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 (112) hide show
  1. package/common/constants.d.ts +43 -0
  2. package/common/constants.js +77 -0
  3. package/common/constants.js.map +1 -0
  4. package/common/helpers/index.d.ts +27 -0
  5. package/common/helpers/index.js +43 -0
  6. package/common/helpers/index.js.map +1 -1
  7. package/common/types/account-setting.types.d.ts +5 -0
  8. package/common/types/account.types.d.ts +6 -6
  9. package/common/types/account.types.js +3 -3
  10. package/common/types/account.types.js.map +1 -1
  11. package/common/types/attribution.types.d.ts +147 -0
  12. package/common/types/attribution.types.js +103 -0
  13. package/common/types/attribution.types.js.map +1 -0
  14. package/common/types/auth.types.d.ts +36 -0
  15. package/common/types/auth.types.js +3 -2
  16. package/common/types/auth.types.js.map +1 -1
  17. package/common/types/cap-table.types.d.ts +225 -53
  18. package/common/types/cap-table.types.js +35 -0
  19. package/common/types/cap-table.types.js.map +1 -1
  20. package/common/types/common.types.d.ts +47 -5
  21. package/common/types/common.types.js +30 -3
  22. package/common/types/common.types.js.map +1 -1
  23. package/common/types/comply-advantage-api.types.d.ts +12 -12
  24. package/common/types/csv.types.d.ts +3612 -0
  25. package/common/types/csv.types.js +290 -0
  26. package/common/types/csv.types.js.map +1 -0
  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 +945 -13
  31. package/common/types/disbursements.types.js +93 -3
  32. package/common/types/disbursements.types.js.map +1 -1
  33. package/common/types/exchange-provider.types.d.ts +12 -12
  34. package/common/types/file.types.d.ts +3 -0
  35. package/common/types/file.types.js +3 -0
  36. package/common/types/file.types.js.map +1 -1
  37. package/common/types/index.d.ts +3 -2
  38. package/common/types/index.js +3 -2
  39. package/common/types/index.js.map +1 -1
  40. package/common/types/individuals.types.d.ts +395 -5
  41. package/common/types/individuals.types.js +11 -14
  42. package/common/types/individuals.types.js.map +1 -1
  43. package/common/types/investor-account.types.d.ts +1 -1
  44. package/common/types/investor-account.types.js +3 -2
  45. package/common/types/investor-account.types.js.map +1 -1
  46. package/common/types/investors-offering.types.d.ts +8 -0
  47. package/common/types/investors-offering.types.js +1 -0
  48. package/common/types/investors-offering.types.js.map +1 -1
  49. package/common/types/invite.types.d.ts +5 -2
  50. package/common/types/invite.types.js +2 -1
  51. package/common/types/invite.types.js.map +1 -1
  52. package/common/types/issuer-offering.types.d.ts +344 -12
  53. package/common/types/issuer-offering.types.js +182 -32
  54. package/common/types/issuer-offering.types.js.map +1 -1
  55. package/common/types/legal-entity.types.d.ts +39 -1
  56. package/common/types/legal-entity.types.js +8 -5
  57. package/common/types/legal-entity.types.js.map +1 -1
  58. package/common/types/mail-template.types.d.ts +4 -4
  59. package/common/types/notification.types.d.ts +1 -0
  60. package/common/types/notification.types.js +3 -0
  61. package/common/types/notification.types.js.map +1 -1
  62. package/common/types/offering-submission.types.js +1 -1
  63. package/common/types/offering.types.d.ts +233 -31
  64. package/common/types/offering.types.js +229 -19
  65. package/common/types/offering.types.js.map +1 -1
  66. package/common/types/payment-methods.types.d.ts +365 -0
  67. package/common/types/payment-methods.types.js +121 -0
  68. package/common/types/payment-methods.types.js.map +1 -1
  69. package/common/types/portfolio.types.d.ts +6 -6
  70. package/common/types/reports.types.d.ts +12 -12
  71. package/common/types/review.types.js +1 -1
  72. package/common/types/review.types.js.map +1 -1
  73. package/common/types/secondary-order.types.d.ts +10 -10
  74. package/common/types/secondary-trade.types.d.ts +10 -10
  75. package/common/types/site.types.d.ts +12 -12
  76. package/common/types/state-machine.types.d.ts +3 -3
  77. package/common/types/state-machine.types.js +1 -1
  78. package/common/types/state-machine.types.js.map +1 -1
  79. package/common/types/task.types.d.ts +8 -0
  80. package/common/types/task.types.js +3 -0
  81. package/common/types/task.types.js.map +1 -1
  82. package/common/types/trade-line-item.types.d.ts +24 -0
  83. package/common/types/trade-line-item.types.js +3 -0
  84. package/common/types/trade-line-item.types.js.map +1 -1
  85. package/common/types/trade.types.d.ts +20 -14
  86. package/common/types/trade.types.js +18 -7
  87. package/common/types/trade.types.js.map +1 -1
  88. package/common/types/transaction.types.d.ts +24 -2
  89. package/common/types/transaction.types.js +26 -1
  90. package/common/types/transaction.types.js.map +1 -1
  91. package/common/types/user.types.d.ts +79 -82
  92. package/common/types/user.types.js +7 -23
  93. package/common/types/user.types.js.map +1 -1
  94. package/common/types/zapier.types.d.ts +126 -0
  95. package/common/types/zapier.types.js +247 -0
  96. package/common/types/zapier.types.js.map +1 -0
  97. package/contracts/clients/csv/index.d.ts +1988 -0
  98. package/contracts/clients/csv/index.js +96 -0
  99. package/contracts/clients/csv/index.js.map +1 -0
  100. package/contracts/clients/index.d.ts +4019 -1061
  101. package/contracts/clients/index.js +8 -2
  102. package/contracts/clients/index.js.map +1 -1
  103. package/contracts/clients/individuals/index.d.ts +381 -5
  104. package/contracts/clients/legal-entities/index.d.ts +1 -1
  105. package/contracts/clients/offerings/index.d.ts +90 -5
  106. package/contracts/clients/review/index.d.ts +85 -0
  107. package/contracts/clients/review/index.js +27 -0
  108. package/contracts/clients/review/index.js.map +1 -0
  109. package/contracts/clients/webhooks/index.d.ts +506 -0
  110. package/contracts/clients/webhooks/index.js +118 -0
  111. package/contracts/clients/webhooks/index.js.map +1 -0
  112. package/package.json +1 -1
@@ -43,7 +43,7 @@ export const OfferingsRevisionReviewZod = z.object({
43
43
  name: z
44
44
  .string({ message: 'Name field is required.' })
45
45
  .min(2, { message: 'Name should have at least 2 characters.' })
46
- .max(100, { message: 'Name can’t be longer than 100 characters.' }),
46
+ .max(150, { message: 'Name can’t be longer than 150 characters.' }),
47
47
  description: z
48
48
  .string({ message: 'Description field is required.' })
49
49
  .min(1, { message: 'Description should have at least 1 character.' })
@@ -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;
@@ -409,7 +445,7 @@ export declare const ResolvedOfferingUpdateFieldsZod: z.ZodObject<{
409
445
  export type ResolvedOfferingUpdateFields = z.infer<typeof ResolvedOfferingUpdateFieldsZod>;
410
446
  export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
411
447
  name: z.ZodOptional<z.ZodString>;
412
- 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>;
413
449
  tid: z.ZodOptional<z.ZodString>;
414
450
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
415
451
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -449,11 +485,11 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
449
485
  subscriptionAgreementId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
450
486
  jointSubscriptionAgreementTemplateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
451
487
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
452
- showTotalRaised: z.ZodOptional<z.ZodBoolean>;
453
488
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
454
489
  } & {
455
490
  accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
456
491
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
492
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
457
493
  assetName: z.ZodString;
458
494
  assetType: z.ZodNativeEnum<typeof AssetType>;
459
495
  pricePerUnit: z.ZodNullable<z.ZodNumber>;
@@ -504,10 +540,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
504
540
  startAmount: number;
505
541
  endAmount: number;
506
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>>;
507
551
  }, "strip", z.ZodTypeAny, {
508
552
  accountId: string;
509
553
  template: AssetTemplateType;
510
554
  platformSettings: string | null;
555
+ warrantsEnabled: boolean;
511
556
  assetName: string;
512
557
  assetType: AssetType;
513
558
  pricePerUnit: number | null;
@@ -535,6 +580,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
535
580
  hasEscrow?: boolean | undefined;
536
581
  bankAccountId?: string | null | undefined;
537
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;
538
590
  yield?: number | null | undefined;
539
591
  duration?: number | null | undefined;
540
592
  durationType?: DurationType | null | undefined;
@@ -586,6 +638,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
586
638
  hasEscrow?: boolean | undefined;
587
639
  bankAccountId?: string | null | undefined;
588
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;
589
649
  yield?: number | null | undefined;
590
650
  duration?: number | null | undefined;
591
651
  durationType?: DurationType | null | undefined;
@@ -605,6 +665,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
605
665
  accountId: string;
606
666
  template: AssetTemplateType;
607
667
  platformSettings: string | null;
668
+ warrantsEnabled: boolean;
608
669
  assetName: string;
609
670
  assetType: AssetType;
610
671
  pricePerUnit: number | null;
@@ -632,6 +693,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
632
693
  hasEscrow?: boolean | undefined;
633
694
  bankAccountId?: string | null | undefined;
634
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;
635
703
  yield?: number | null | undefined;
636
704
  duration?: number | null | undefined;
637
705
  durationType?: DurationType | null | undefined;
@@ -683,6 +751,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
683
751
  hasEscrow?: boolean | undefined;
684
752
  bankAccountId?: string | null | undefined;
685
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;
686
762
  yield?: number | null | undefined;
687
763
  duration?: number | null | undefined;
688
764
  durationType?: DurationType | null | undefined;
@@ -700,7 +776,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
700
776
  jointSubscriptionAgreementTemplateId?: string | null | undefined;
701
777
  }>;
702
778
  export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
703
- 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"]>;
704
780
  /**
705
781
  * @description Query parameters for including related entities
706
782
  * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
@@ -715,23 +791,27 @@ export declare const OfferingsIncludeQuery: z.ZodObject<{
715
791
  export interface OfferingsIncludeQuery extends z.infer<typeof OfferingsIncludeQuery> {
716
792
  }
717
793
  /**
718
- * @description
719
- * Filters for querying offerings.
794
+ * Filters supported for querying offerings.
720
795
  *
721
- * The "combinedStatus" filter provides a unified status that combines three separate fields:
722
- * - complianceReview: The compliance review status of the offering
723
- * - onboardingStatus: The onboarding completion status
724
- * - 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.
725
807
  *
726
- * The combinedStatus is calculated using the following priority rules:
727
- * 1. If onboardingStatus is "IN_REVIEW" combinedStatus = "ONBOARDING"
728
- * 2. Else if complianceReview is not "APPROVED" → combinedStatus = "IN_COMPLIANCE_REVIEW"
729
- * 3. Else if onboardingStatus is "COMPLETE" and complianceReview is "APPROVED" →
730
- * - If enabled is true → combinedStatus = "ACTIVE"
731
- * - If enabled is false → combinedStatus = "PAUSED"
808
+ * @remarks
809
+ * These filters can be combined to query offerings across multiple dimensions.
732
810
  *
733
- * This allows for filtering offerings by a single summary state that reflects the overall user-facing status,
734
- * rather than requiring separate filters for each individual field.
811
+ * Example use:
812
+ * ```ts
813
+ * { issuerName: "ABC Capital", type: OfferingType.REG_A }
814
+ * ```
735
815
  */
736
816
  export declare const OfferingFiltersZod: z.ZodObject<{
737
817
  issuerName: z.ZodOptional<z.ZodString>;
@@ -743,32 +823,32 @@ export declare const OfferingFiltersZod: z.ZodObject<{
743
823
  enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
744
824
  managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
745
825
  versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
746
- combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
747
826
  onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingOnboardingStatus>>;
827
+ complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
748
828
  }, "strip", z.ZodTypeAny, {
749
829
  type?: OfferingType | undefined;
750
830
  status?: ComplianceReview | undefined;
751
831
  accountId?: string | undefined;
752
832
  name?: string | undefined;
753
833
  managedBy?: ManagedByType | undefined;
834
+ complianceReview?: ComplianceReview | undefined;
754
835
  onboardingStatus?: OfferingOnboardingStatus | undefined;
755
836
  enabled?: boolean | undefined;
756
837
  issuerId?: string | undefined;
757
838
  issuerName?: string | undefined;
758
839
  versioningType?: OfferingVersioningType | undefined;
759
- combinedStatus?: OfferingStatus | undefined;
760
840
  }, {
761
841
  type?: OfferingType | undefined;
762
842
  status?: ComplianceReview | undefined;
763
843
  accountId?: string | undefined;
764
844
  name?: string | undefined;
765
845
  managedBy?: ManagedByType | undefined;
846
+ complianceReview?: ComplianceReview | undefined;
766
847
  onboardingStatus?: OfferingOnboardingStatus | undefined;
767
848
  enabled?: unknown;
768
849
  issuerId?: string | undefined;
769
850
  issuerName?: string | undefined;
770
851
  versioningType?: OfferingVersioningType | undefined;
771
- combinedStatus?: OfferingStatus | undefined;
772
852
  }>;
773
853
  export type OfferingFiltersZod = z.infer<typeof OfferingFiltersZod>;
774
854
  export declare const OfferingSortZod: z.ZodObject<{
@@ -1195,7 +1275,7 @@ export declare const OfferingSettings: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.
1195
1275
  export type OfferingSettings = z.infer<typeof OfferingSettings>;
1196
1276
  export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.ZodObject<{
1197
1277
  name: z.ZodOptional<z.ZodString>;
1198
- 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>;
1199
1279
  tid: z.ZodOptional<z.ZodString>;
1200
1280
  type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
1201
1281
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -1238,6 +1318,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1238
1318
  cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
1239
1319
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
1240
1320
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
1321
+ shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1241
1322
  } & {
1242
1323
  assetName: z.ZodOptional<z.ZodString>;
1243
1324
  assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -1290,6 +1371,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1290
1371
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1291
1372
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
1292
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>>>;
1293
1381
  }, "strip", z.ZodTypeAny, {
1294
1382
  platformSettings: string | null;
1295
1383
  type?: OfferingType | undefined;
@@ -1317,6 +1405,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1317
1405
  escrowAgreementFileId?: string | null | undefined;
1318
1406
  bankAccountId?: string | null | undefined;
1319
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;
1320
1416
  assetName?: string | undefined;
1321
1417
  assetType?: AssetType | undefined;
1322
1418
  pricePerUnit?: number | null | undefined;
@@ -1368,6 +1464,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1368
1464
  escrowAgreementFileId?: string | null | undefined;
1369
1465
  bankAccountId?: string | null | undefined;
1370
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;
1371
1475
  assetName?: string | undefined;
1372
1476
  assetType?: AssetType | undefined;
1373
1477
  pricePerUnit?: number | null | undefined;
@@ -1645,6 +1749,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1645
1749
  escrowAgreementFileId?: string | null | undefined;
1646
1750
  bankAccountId?: string | null | undefined;
1647
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;
1648
1760
  assetName?: string | undefined;
1649
1761
  assetType?: AssetType | undefined;
1650
1762
  pricePerUnit?: number | null | undefined;
@@ -1707,6 +1819,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
1707
1819
  escrowAgreementFileId?: string | null | undefined;
1708
1820
  bankAccountId?: string | null | undefined;
1709
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;
1710
1830
  assetName?: string | undefined;
1711
1831
  assetType?: AssetType | undefined;
1712
1832
  pricePerUnit?: number | null | undefined;
@@ -2460,6 +2580,7 @@ export type OfferingUpdateFields = {
2460
2580
  managedBy?: ManagedByType | null;
2461
2581
  showTotalRaised?: boolean;
2462
2582
  enabled?: boolean;
2583
+ shareClassId?: string | null;
2463
2584
  };
2464
2585
  export declare const ReviewOfferingOnboarding: z.ZodObject<{
2465
2586
  onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
@@ -2485,20 +2606,20 @@ export declare const OnboardingOfferingSummaryZod: z.ZodObject<{
2485
2606
  offeringId: string;
2486
2607
  memorandumId: string | null;
2487
2608
  subscriptionAgreementId: string | null;
2609
+ offeringName: string;
2488
2610
  entitySubscriptionAgreementTemplateId: string | null;
2489
2611
  subscriptionAgreementTemplateId: string | null;
2490
2612
  jointSubscriptionAgreementTemplateId: string | null;
2491
- offeringName: string;
2492
2613
  }, {
2493
2614
  accountId: string;
2494
2615
  accountName: string;
2495
2616
  offeringId: string;
2496
2617
  memorandumId: string | null;
2497
2618
  subscriptionAgreementId: string | null;
2619
+ offeringName: string;
2498
2620
  entitySubscriptionAgreementTemplateId: string | null;
2499
2621
  subscriptionAgreementTemplateId: string | null;
2500
2622
  jointSubscriptionAgreementTemplateId: string | null;
2501
- offeringName: string;
2502
2623
  }>;
2503
2624
  export type OnboardingOfferingSummaryZod = z.infer<typeof OnboardingOfferingSummaryZod>;
2504
2625
  export declare const OnboardingOfferingSummaryFilterZod: z.ZodObject<{
@@ -2529,20 +2650,20 @@ export declare const IPaginatedOnboardingOfferingSummaryResponse: z.ZodObject<{
2529
2650
  offeringId: string;
2530
2651
  memorandumId: string | null;
2531
2652
  subscriptionAgreementId: string | null;
2653
+ offeringName: string;
2532
2654
  entitySubscriptionAgreementTemplateId: string | null;
2533
2655
  subscriptionAgreementTemplateId: string | null;
2534
2656
  jointSubscriptionAgreementTemplateId: string | null;
2535
- offeringName: string;
2536
2657
  }, {
2537
2658
  accountId: string;
2538
2659
  accountName: string;
2539
2660
  offeringId: string;
2540
2661
  memorandumId: string | null;
2541
2662
  subscriptionAgreementId: string | null;
2663
+ offeringName: string;
2542
2664
  entitySubscriptionAgreementTemplateId: string | null;
2543
2665
  subscriptionAgreementTemplateId: string | null;
2544
2666
  jointSubscriptionAgreementTemplateId: string | null;
2545
- offeringName: string;
2546
2667
  }>, "many">;
2547
2668
  meta: z.ZodObject<{
2548
2669
  itemCount: z.ZodNumber;
@@ -2570,10 +2691,10 @@ export declare const IPaginatedOnboardingOfferingSummaryResponse: z.ZodObject<{
2570
2691
  offeringId: string;
2571
2692
  memorandumId: string | null;
2572
2693
  subscriptionAgreementId: string | null;
2694
+ offeringName: string;
2573
2695
  entitySubscriptionAgreementTemplateId: string | null;
2574
2696
  subscriptionAgreementTemplateId: string | null;
2575
2697
  jointSubscriptionAgreementTemplateId: string | null;
2576
- offeringName: string;
2577
2698
  }[];
2578
2699
  meta: {
2579
2700
  itemCount: number;
@@ -2589,10 +2710,10 @@ export declare const IPaginatedOnboardingOfferingSummaryResponse: z.ZodObject<{
2589
2710
  offeringId: string;
2590
2711
  memorandumId: string | null;
2591
2712
  subscriptionAgreementId: string | null;
2713
+ offeringName: string;
2592
2714
  entitySubscriptionAgreementTemplateId: string | null;
2593
2715
  subscriptionAgreementTemplateId: string | null;
2594
2716
  jointSubscriptionAgreementTemplateId: string | null;
2595
- offeringName: string;
2596
2717
  }[];
2597
2718
  meta: {
2598
2719
  itemCount: number;
@@ -2655,3 +2776,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
2655
2776
  currentEscrowAgreementFileId: string | null;
2656
2777
  }>;
2657
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;