@dalmore/api-contracts 0.0.0-dev.27db984 → 0.0.0-dev.2c95652
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.
- package/common/types/account-setting.types.d.ts +22 -66
- package/common/types/account-setting.types.js +2 -31
- package/common/types/account-setting.types.js.map +1 -1
- package/common/types/account.types.d.ts +32 -23
- package/common/types/account.types.js +1 -0
- package/common/types/account.types.js.map +1 -1
- package/common/types/activity.types.d.ts +8 -1
- package/common/types/activity.types.js +7 -0
- package/common/types/activity.types.js.map +1 -1
- package/common/types/auth.types.d.ts +36 -0
- package/common/types/auth.types.js +3 -2
- package/common/types/auth.types.js.map +1 -1
- package/common/types/cap-table.types.d.ts +162 -53
- package/common/types/cap-table.types.js +14 -0
- package/common/types/cap-table.types.js.map +1 -1
- package/common/types/common.types.d.ts +327 -2
- package/common/types/common.types.js +52 -1
- package/common/types/common.types.js.map +1 -1
- package/common/types/csv.types.d.ts +1557 -0
- package/common/types/csv.types.js +154 -0
- package/common/types/csv.types.js.map +1 -0
- package/common/types/disbursement-transaction.types.d.ts +1 -1
- package/common/types/disbursement-transaction.types.js +1 -1
- package/common/types/disbursement-transaction.types.js.map +1 -1
- package/common/types/disbursements.types.d.ts +939 -7
- package/common/types/disbursements.types.js +92 -2
- package/common/types/disbursements.types.js.map +1 -1
- package/common/types/exchange-provider.types.d.ts +12 -12
- package/common/types/file.types.d.ts +3 -0
- package/common/types/file.types.js +3 -0
- package/common/types/file.types.js.map +1 -1
- package/common/types/index.d.ts +3 -0
- package/common/types/index.js +3 -0
- package/common/types/index.js.map +1 -1
- package/common/types/individuals.types.d.ts +207 -5
- package/common/types/individuals.types.js +11 -14
- package/common/types/individuals.types.js.map +1 -1
- package/common/types/investor-account.types.d.ts +1 -1
- package/common/types/investor-account.types.js +1 -2
- package/common/types/investor-account.types.js.map +1 -1
- package/common/types/invite.types.d.ts +2 -2
- package/common/types/invite.types.js +1 -1
- package/common/types/invite.types.js.map +1 -1
- package/common/types/issuer-offering.types.d.ts +171 -10
- package/common/types/issuer-offering.types.js +173 -12
- package/common/types/issuer-offering.types.js.map +1 -1
- package/common/types/legal-entity.types.d.ts +39 -1
- package/common/types/legal-entity.types.js +8 -5
- package/common/types/legal-entity.types.js.map +1 -1
- package/common/types/offering.types.d.ts +255 -21
- package/common/types/offering.types.js +219 -18
- package/common/types/offering.types.js.map +1 -1
- package/common/types/portfolio.types.d.ts +6 -6
- package/common/types/review.types.js +1 -1
- package/common/types/review.types.js.map +1 -1
- package/common/types/secondary-order.types.d.ts +10 -10
- package/common/types/secondary-trade.types.d.ts +10 -10
- package/common/types/site.types.d.ts +12 -12
- package/common/types/trade-line-item.types.d.ts +24 -0
- package/common/types/trade-line-item.types.js +3 -0
- package/common/types/trade-line-item.types.js.map +1 -1
- package/common/types/trade.types.d.ts +9 -0
- package/common/types/trade.types.js +8 -1
- package/common/types/trade.types.js.map +1 -1
- package/common/types/transaction.types.d.ts +0 -1
- package/common/types/transaction.types.js +0 -1
- package/common/types/transaction.types.js.map +1 -1
- package/common/types/user.types.d.ts +162 -59
- package/common/types/user.types.js +6 -1
- package/common/types/user.types.js.map +1 -1
- package/contracts/clients/csv/index.d.ts +1594 -0
- package/contracts/clients/csv/index.js +62 -0
- package/contracts/clients/csv/index.js.map +1 -0
- package/contracts/clients/index.d.ts +1765 -9
- package/contracts/clients/index.js +4 -0
- package/contracts/clients/index.js.map +1 -1
- package/contracts/clients/individuals/index.d.ts +5 -5
- package/contracts/clients/legal-entities/index.d.ts +1 -1
- package/contracts/clients/offerings/index.d.ts +88 -3
- package/contracts/clients/review/index.d.ts +77 -0
- package/contracts/clients/review/index.js +23 -0
- package/contracts/clients/review/index.js.map +1 -0
- 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",
|
|
@@ -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>>;
|
|
@@ -266,6 +269,13 @@ export declare const PatchOffering: z.ZodObject<{
|
|
|
266
269
|
bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
267
270
|
escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
268
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>>>;
|
|
269
279
|
}, "strip", z.ZodTypeAny, {
|
|
270
280
|
platformSettings: string | null;
|
|
271
281
|
type?: OfferingType | undefined;
|
|
@@ -293,6 +303,14 @@ export declare const PatchOffering: z.ZodObject<{
|
|
|
293
303
|
escrowAgreementFileId?: string | null | undefined;
|
|
294
304
|
bankAccountId?: string | null | undefined;
|
|
295
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;
|
|
296
314
|
assetName?: string | undefined;
|
|
297
315
|
assetType?: AssetType | undefined;
|
|
298
316
|
pricePerUnit?: number | null | undefined;
|
|
@@ -344,6 +362,14 @@ export declare const PatchOffering: z.ZodObject<{
|
|
|
344
362
|
escrowAgreementFileId?: string | null | undefined;
|
|
345
363
|
bankAccountId?: string | null | undefined;
|
|
346
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;
|
|
347
373
|
assetName?: string | undefined;
|
|
348
374
|
assetType?: AssetType | undefined;
|
|
349
375
|
pricePerUnit?: number | null | undefined;
|
|
@@ -365,6 +391,48 @@ export declare const PatchOffering: z.ZodObject<{
|
|
|
365
391
|
jointSubscriptionAgreementTemplateId?: string | null | undefined;
|
|
366
392
|
}>;
|
|
367
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>;
|
|
368
436
|
export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
369
437
|
name: z.ZodOptional<z.ZodString>;
|
|
370
438
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -407,11 +475,11 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
407
475
|
subscriptionAgreementId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
408
476
|
jointSubscriptionAgreementTemplateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
409
477
|
cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
410
|
-
showTotalRaised: z.ZodOptional<z.ZodBoolean>;
|
|
411
478
|
issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
412
479
|
} & {
|
|
413
480
|
accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
|
|
414
481
|
managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
|
|
482
|
+
shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
415
483
|
assetName: z.ZodString;
|
|
416
484
|
assetType: z.ZodNativeEnum<typeof AssetType>;
|
|
417
485
|
pricePerUnit: z.ZodNullable<z.ZodNumber>;
|
|
@@ -462,10 +530,19 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
462
530
|
startAmount: number;
|
|
463
531
|
endAmount: number;
|
|
464
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>>;
|
|
465
541
|
}, "strip", z.ZodTypeAny, {
|
|
466
542
|
accountId: string;
|
|
467
543
|
template: AssetTemplateType;
|
|
468
544
|
platformSettings: string | null;
|
|
545
|
+
warrantsEnabled: boolean;
|
|
469
546
|
assetName: string;
|
|
470
547
|
assetType: AssetType;
|
|
471
548
|
pricePerUnit: number | null;
|
|
@@ -493,6 +570,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
493
570
|
hasEscrow?: boolean | undefined;
|
|
494
571
|
bankAccountId?: string | null | undefined;
|
|
495
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;
|
|
496
580
|
yield?: number | null | undefined;
|
|
497
581
|
duration?: number | null | undefined;
|
|
498
582
|
durationType?: DurationType | null | undefined;
|
|
@@ -544,6 +628,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
544
628
|
hasEscrow?: boolean | undefined;
|
|
545
629
|
bankAccountId?: string | null | undefined;
|
|
546
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;
|
|
547
639
|
yield?: number | null | undefined;
|
|
548
640
|
duration?: number | null | undefined;
|
|
549
641
|
durationType?: DurationType | null | undefined;
|
|
@@ -563,6 +655,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
563
655
|
accountId: string;
|
|
564
656
|
template: AssetTemplateType;
|
|
565
657
|
platformSettings: string | null;
|
|
658
|
+
warrantsEnabled: boolean;
|
|
566
659
|
assetName: string;
|
|
567
660
|
assetType: AssetType;
|
|
568
661
|
pricePerUnit: number | null;
|
|
@@ -590,6 +683,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
590
683
|
hasEscrow?: boolean | undefined;
|
|
591
684
|
bankAccountId?: string | null | undefined;
|
|
592
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;
|
|
593
693
|
yield?: number | null | undefined;
|
|
594
694
|
duration?: number | null | undefined;
|
|
595
695
|
durationType?: DurationType | null | undefined;
|
|
@@ -641,6 +741,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
641
741
|
hasEscrow?: boolean | undefined;
|
|
642
742
|
bankAccountId?: string | null | undefined;
|
|
643
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;
|
|
644
752
|
yield?: number | null | undefined;
|
|
645
753
|
duration?: number | null | undefined;
|
|
646
754
|
durationType?: DurationType | null | undefined;
|
|
@@ -658,7 +766,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
|
|
|
658
766
|
jointSubscriptionAgreementTemplateId?: string | null | undefined;
|
|
659
767
|
}>;
|
|
660
768
|
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"]>;
|
|
769
|
+
export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount", "shareClass"]>;
|
|
662
770
|
/**
|
|
663
771
|
* @description Query parameters for including related entities
|
|
664
772
|
* @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
|
|
@@ -673,23 +781,27 @@ export declare const OfferingsIncludeQuery: z.ZodObject<{
|
|
|
673
781
|
export interface OfferingsIncludeQuery extends z.infer<typeof OfferingsIncludeQuery> {
|
|
674
782
|
}
|
|
675
783
|
/**
|
|
676
|
-
*
|
|
677
|
-
* Filters for querying offerings.
|
|
784
|
+
* Filters supported for querying offerings.
|
|
678
785
|
*
|
|
679
|
-
*
|
|
680
|
-
* -
|
|
681
|
-
* -
|
|
682
|
-
* -
|
|
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.
|
|
683
797
|
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
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"
|
|
798
|
+
* @remarks
|
|
799
|
+
* These filters can be combined to query offerings across multiple dimensions.
|
|
690
800
|
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
801
|
+
* Example use:
|
|
802
|
+
* ```ts
|
|
803
|
+
* { issuerName: "ABC Capital", type: OfferingType.REG_A }
|
|
804
|
+
* ```
|
|
693
805
|
*/
|
|
694
806
|
export declare const OfferingFiltersZod: z.ZodObject<{
|
|
695
807
|
issuerName: z.ZodOptional<z.ZodString>;
|
|
@@ -701,32 +813,32 @@ export declare const OfferingFiltersZod: z.ZodObject<{
|
|
|
701
813
|
enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
|
|
702
814
|
managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
|
|
703
815
|
versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
|
|
704
|
-
combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
|
|
705
816
|
onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingOnboardingStatus>>;
|
|
817
|
+
complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
|
|
706
818
|
}, "strip", z.ZodTypeAny, {
|
|
707
819
|
type?: OfferingType | undefined;
|
|
708
820
|
status?: ComplianceReview | undefined;
|
|
709
821
|
accountId?: string | undefined;
|
|
710
822
|
name?: string | undefined;
|
|
711
823
|
managedBy?: ManagedByType | undefined;
|
|
824
|
+
complianceReview?: ComplianceReview | undefined;
|
|
712
825
|
onboardingStatus?: OfferingOnboardingStatus | undefined;
|
|
713
826
|
enabled?: boolean | undefined;
|
|
714
827
|
issuerId?: string | undefined;
|
|
715
828
|
issuerName?: string | undefined;
|
|
716
829
|
versioningType?: OfferingVersioningType | undefined;
|
|
717
|
-
combinedStatus?: OfferingStatus | undefined;
|
|
718
830
|
}, {
|
|
719
831
|
type?: OfferingType | undefined;
|
|
720
832
|
status?: ComplianceReview | undefined;
|
|
721
833
|
accountId?: string | undefined;
|
|
722
834
|
name?: string | undefined;
|
|
723
835
|
managedBy?: ManagedByType | undefined;
|
|
836
|
+
complianceReview?: ComplianceReview | undefined;
|
|
724
837
|
onboardingStatus?: OfferingOnboardingStatus | undefined;
|
|
725
838
|
enabled?: unknown;
|
|
726
839
|
issuerId?: string | undefined;
|
|
727
840
|
issuerName?: string | undefined;
|
|
728
841
|
versioningType?: OfferingVersioningType | undefined;
|
|
729
|
-
combinedStatus?: OfferingStatus | undefined;
|
|
730
842
|
}>;
|
|
731
843
|
export type OfferingFiltersZod = z.infer<typeof OfferingFiltersZod>;
|
|
732
844
|
export declare const OfferingSortZod: z.ZodObject<{
|
|
@@ -1196,6 +1308,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1196
1308
|
cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1197
1309
|
showTotalRaised: z.ZodOptional<z.ZodBoolean>;
|
|
1198
1310
|
issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
1311
|
+
shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
1199
1312
|
} & {
|
|
1200
1313
|
assetName: z.ZodOptional<z.ZodString>;
|
|
1201
1314
|
assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
|
|
@@ -1248,6 +1361,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1248
1361
|
bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
1249
1362
|
escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
|
|
1250
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>>>;
|
|
1251
1371
|
}, "strip", z.ZodTypeAny, {
|
|
1252
1372
|
platformSettings: string | null;
|
|
1253
1373
|
type?: OfferingType | undefined;
|
|
@@ -1275,6 +1395,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1275
1395
|
escrowAgreementFileId?: string | null | undefined;
|
|
1276
1396
|
bankAccountId?: string | null | undefined;
|
|
1277
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;
|
|
1278
1406
|
assetName?: string | undefined;
|
|
1279
1407
|
assetType?: AssetType | undefined;
|
|
1280
1408
|
pricePerUnit?: number | null | undefined;
|
|
@@ -1326,6 +1454,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1326
1454
|
escrowAgreementFileId?: string | null | undefined;
|
|
1327
1455
|
bankAccountId?: string | null | undefined;
|
|
1328
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;
|
|
1329
1465
|
assetName?: string | undefined;
|
|
1330
1466
|
assetType?: AssetType | undefined;
|
|
1331
1467
|
pricePerUnit?: number | null | undefined;
|
|
@@ -1603,6 +1739,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1603
1739
|
escrowAgreementFileId?: string | null | undefined;
|
|
1604
1740
|
bankAccountId?: string | null | undefined;
|
|
1605
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;
|
|
1606
1750
|
assetName?: string | undefined;
|
|
1607
1751
|
assetType?: AssetType | undefined;
|
|
1608
1752
|
pricePerUnit?: number | null | undefined;
|
|
@@ -1665,6 +1809,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
|
|
|
1665
1809
|
escrowAgreementFileId?: string | null | undefined;
|
|
1666
1810
|
bankAccountId?: string | null | undefined;
|
|
1667
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;
|
|
1668
1820
|
assetName?: string | undefined;
|
|
1669
1821
|
assetType?: AssetType | undefined;
|
|
1670
1822
|
pricePerUnit?: number | null | undefined;
|
|
@@ -2418,6 +2570,7 @@ export type OfferingUpdateFields = {
|
|
|
2418
2570
|
managedBy?: ManagedByType | null;
|
|
2419
2571
|
showTotalRaised?: boolean;
|
|
2420
2572
|
enabled?: boolean;
|
|
2573
|
+
shareClassId?: string | null;
|
|
2421
2574
|
};
|
|
2422
2575
|
export declare const ReviewOfferingOnboarding: z.ZodObject<{
|
|
2423
2576
|
onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
|
|
@@ -2613,3 +2766,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
|
|
|
2613
2766
|
currentEscrowAgreementFileId: string | null;
|
|
2614
2767
|
}>;
|
|
2615
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;
|