@dalmore/api-contracts 0.0.0-dev.2982281 → 0.0.0-dev.2cea8e5

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 (61) hide show
  1. package/common/types/account-setting.types.d.ts +17 -66
  2. package/common/types/account-setting.types.js +2 -31
  3. package/common/types/account-setting.types.js.map +1 -1
  4. package/common/types/account.types.d.ts +32 -23
  5. package/common/types/account.types.js +1 -0
  6. package/common/types/account.types.js.map +1 -1
  7. package/common/types/activity.types.d.ts +34 -25
  8. package/common/types/activity.types.js +11 -0
  9. package/common/types/activity.types.js.map +1 -1
  10. package/common/types/asset.types.d.ts +25 -111
  11. package/common/types/asset.types.js +24 -100
  12. package/common/types/asset.types.js.map +1 -1
  13. package/common/types/bonus-tier.types.d.ts +0 -30
  14. package/common/types/cap-table.types.d.ts +29 -14
  15. package/common/types/cap-table.types.js +17 -0
  16. package/common/types/cap-table.types.js.map +1 -1
  17. package/common/types/common.types.d.ts +312 -2
  18. package/common/types/common.types.js +48 -1
  19. package/common/types/common.types.js.map +1 -1
  20. package/common/types/dashboard.types.d.ts +7 -7
  21. package/common/types/disbursements.types.d.ts +834 -0
  22. package/common/types/disbursements.types.js +63 -0
  23. package/common/types/disbursements.types.js.map +1 -1
  24. package/common/types/escrow-account.types.d.ts +17 -0
  25. package/common/types/escrow-account.types.js +3 -0
  26. package/common/types/escrow-account.types.js.map +1 -1
  27. package/common/types/file.types.d.ts +30 -9
  28. package/common/types/file.types.js +9 -0
  29. package/common/types/file.types.js.map +1 -1
  30. package/common/types/index.d.ts +2 -0
  31. package/common/types/index.js +2 -0
  32. package/common/types/index.js.map +1 -1
  33. package/common/types/individuals.types.js +1 -1
  34. package/common/types/individuals.types.js.map +1 -1
  35. package/common/types/issuer-offering.types.d.ts +160 -73
  36. package/common/types/issuer-offering.types.js +150 -38
  37. package/common/types/issuer-offering.types.js.map +1 -1
  38. package/common/types/job-item.types.d.ts +14 -14
  39. package/common/types/note.types.d.ts +15 -15
  40. package/common/types/offering-submission.types.d.ts +198 -0
  41. package/common/types/offering-submission.types.js +16 -3
  42. package/common/types/offering-submission.types.js.map +1 -1
  43. package/common/types/offering.types.d.ts +217 -42
  44. package/common/types/offering.types.js +166 -38
  45. package/common/types/offering.types.js.map +1 -1
  46. package/common/types/reports.types.d.ts +345 -0
  47. package/common/types/reports.types.js +69 -0
  48. package/common/types/reports.types.js.map +1 -0
  49. package/common/types/site.types.d.ts +0 -15
  50. package/common/types/task.types.d.ts +22 -22
  51. package/common/types/trade.types.js +1 -0
  52. package/common/types/trade.types.js.map +1 -1
  53. package/common/types/user.types.d.ts +107 -59
  54. package/common/types/user.types.js +7 -1
  55. package/common/types/user.types.js.map +1 -1
  56. package/contracts/clients/assets/index.d.ts +0 -66
  57. package/contracts/clients/files/index.d.ts +3 -3
  58. package/contracts/clients/files-public/index.d.ts +3 -3
  59. package/contracts/clients/index.d.ts +76 -107
  60. package/contracts/clients/offerings/index.d.ts +70 -35
  61. package/package.json +1 -1
package/contracts/clients/offerings/index.d.ts CHANGED
@@ -426,7 +426,6 @@ export declare const offeringsContract: {
426
426
  memorandumId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
427
427
  subscriptionAgreementId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
428
428
  coverArtId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
429
- managedBy: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").ManagedByType>>;
430
429
  showTotalRaised: z.ZodOptional<z.ZodBoolean>;
431
430
  issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
432
431
  assetName: z.ZodOptional<z.ZodString>;
@@ -444,10 +443,7 @@ export declare const offeringsContract: {
444
443
  escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
445
444
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
446
445
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
447
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
448
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
449
446
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
450
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
451
447
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
452
448
  type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
453
449
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -484,10 +480,16 @@ export declare const offeringsContract: {
484
480
  startAmount: number;
485
481
  endAmount: number;
486
482
  }>, "many">>;
483
+ warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
484
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
485
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
486
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
487
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
488
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../..").WarrantSharesCalculationMethod>>>;
489
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
487
490
  }, "strip", z.ZodTypeAny, {
488
491
  type?: import("../../..").OfferingType | undefined;
489
492
  name?: string | undefined;
490
- managedBy?: import("../../..").ManagedByType | undefined;
491
493
  description?: string | null | undefined;
492
494
  enabled?: boolean | undefined;
493
495
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -507,6 +509,13 @@ export declare const offeringsContract: {
507
509
  escrowAgreementFileId?: string | null | undefined;
508
510
  bankAccountId?: string | null | undefined;
509
511
  escrowAccountId?: string | null | undefined;
512
+ warrantsEnabled?: boolean | undefined;
513
+ totalShares?: number | null | undefined;
514
+ warrantTermYears?: number | null | undefined;
515
+ exercisePrice?: number | null | undefined;
516
+ warrantPercentage?: number | null | undefined;
517
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
518
+ incrementThreshold?: number | null | undefined;
510
519
  assetName?: string | undefined;
511
520
  assetType?: import("../../..").AssetType | undefined;
512
521
  pricePerUnit?: number | null | undefined;
@@ -516,10 +525,7 @@ export declare const offeringsContract: {
516
525
  durationType?: import("../../..").DurationType | null | undefined;
517
526
  tiers?: number[] | null | undefined;
518
527
  enableBonus?: boolean | undefined;
519
- principalAmount?: number | null | undefined;
520
- maxTotalRaise?: number | null | undefined;
521
528
  interestRate?: number | null | undefined;
522
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
523
529
  bonusTiers?: {
524
530
  value: number;
525
531
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -529,7 +535,6 @@ export declare const offeringsContract: {
529
535
  }, {
530
536
  type?: import("../../..").OfferingType | undefined;
531
537
  name?: string | undefined;
532
- managedBy?: import("../../..").ManagedByType | undefined;
533
538
  description?: string | null | undefined;
534
539
  enabled?: boolean | undefined;
535
540
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -549,6 +554,13 @@ export declare const offeringsContract: {
549
554
  escrowAgreementFileId?: string | null | undefined;
550
555
  bankAccountId?: string | null | undefined;
551
556
  escrowAccountId?: string | null | undefined;
557
+ warrantsEnabled?: boolean | undefined;
558
+ totalShares?: number | null | undefined;
559
+ warrantTermYears?: number | null | undefined;
560
+ exercisePrice?: number | null | undefined;
561
+ warrantPercentage?: number | null | undefined;
562
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
563
+ incrementThreshold?: number | null | undefined;
552
564
  assetName?: string | undefined;
553
565
  assetType?: import("../../..").AssetType | undefined;
554
566
  pricePerUnit?: number | null | undefined;
@@ -558,10 +570,7 @@ export declare const offeringsContract: {
558
570
  durationType?: import("../../..").DurationType | null | undefined;
559
571
  tiers?: number[] | null | undefined;
560
572
  enableBonus?: boolean | undefined;
561
- principalAmount?: number | null | undefined;
562
- maxTotalRaise?: number | null | undefined;
563
573
  interestRate?: number | null | undefined;
564
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
565
574
  bonusTiers?: {
566
575
  value: number;
567
576
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -571,7 +580,6 @@ export declare const offeringsContract: {
571
580
  }>, {
572
581
  type?: import("../../..").OfferingType | undefined;
573
582
  name?: string | undefined;
574
- managedBy?: import("../../..").ManagedByType | undefined;
575
583
  description?: string | null | undefined;
576
584
  enabled?: boolean | undefined;
577
585
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -591,6 +599,13 @@ export declare const offeringsContract: {
591
599
  escrowAgreementFileId?: string | null | undefined;
592
600
  bankAccountId?: string | null | undefined;
593
601
  escrowAccountId?: string | null | undefined;
602
+ warrantsEnabled?: boolean | undefined;
603
+ totalShares?: number | null | undefined;
604
+ warrantTermYears?: number | null | undefined;
605
+ exercisePrice?: number | null | undefined;
606
+ warrantPercentage?: number | null | undefined;
607
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
608
+ incrementThreshold?: number | null | undefined;
594
609
  assetName?: string | undefined;
595
610
  assetType?: import("../../..").AssetType | undefined;
596
611
  pricePerUnit?: number | null | undefined;
@@ -600,10 +615,7 @@ export declare const offeringsContract: {
600
615
  durationType?: import("../../..").DurationType | null | undefined;
601
616
  tiers?: number[] | null | undefined;
602
617
  enableBonus?: boolean | undefined;
603
- principalAmount?: number | null | undefined;
604
- maxTotalRaise?: number | null | undefined;
605
618
  interestRate?: number | null | undefined;
606
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
607
619
  bonusTiers?: {
608
620
  value: number;
609
621
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -613,7 +625,6 @@ export declare const offeringsContract: {
613
625
  }, {
614
626
  type?: import("../../..").OfferingType | undefined;
615
627
  name?: string | undefined;
616
- managedBy?: import("../../..").ManagedByType | undefined;
617
628
  description?: string | null | undefined;
618
629
  enabled?: boolean | undefined;
619
630
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -633,6 +644,13 @@ export declare const offeringsContract: {
633
644
  escrowAgreementFileId?: string | null | undefined;
634
645
  bankAccountId?: string | null | undefined;
635
646
  escrowAccountId?: string | null | undefined;
647
+ warrantsEnabled?: boolean | undefined;
648
+ totalShares?: number | null | undefined;
649
+ warrantTermYears?: number | null | undefined;
650
+ exercisePrice?: number | null | undefined;
651
+ warrantPercentage?: number | null | undefined;
652
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
653
+ incrementThreshold?: number | null | undefined;
636
654
  assetName?: string | undefined;
637
655
  assetType?: import("../../..").AssetType | undefined;
638
656
  pricePerUnit?: number | null | undefined;
@@ -642,10 +660,7 @@ export declare const offeringsContract: {
642
660
  durationType?: import("../../..").DurationType | null | undefined;
643
661
  tiers?: number[] | null | undefined;
644
662
  enableBonus?: boolean | undefined;
645
- principalAmount?: number | null | undefined;
646
- maxTotalRaise?: number | null | undefined;
647
663
  interestRate?: number | null | undefined;
648
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
649
664
  bonusTiers?: {
650
665
  value: number;
651
666
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -764,10 +779,7 @@ export declare const offeringsContract: {
764
779
  hasEscrow: z.ZodOptional<z.ZodBoolean>;
765
780
  bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
766
781
  escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
767
- principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
768
- maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
769
782
  interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
770
- interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
771
783
  bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
772
784
  type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
773
785
  value: z.ZodEffects<z.ZodNumber, number, number>;
@@ -804,12 +816,20 @@ export declare const offeringsContract: {
804
816
  startAmount: number;
805
817
  endAmount: number;
806
818
  }>, "many">>;
819
+ warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
820
+ totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
821
+ warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
822
+ exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
823
+ warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
824
+ calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../..").WarrantSharesCalculationMethod>>>;
825
+ incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
807
826
  }, "strip", z.ZodTypeAny, {
808
827
  type: import("../../..").OfferingType;
809
828
  name: string;
810
829
  template: import("../../../common/types/asset.types").AssetTemplateType;
811
830
  targetAmount: number;
812
831
  issuerId: string;
832
+ warrantsEnabled: boolean;
813
833
  assetName: string;
814
834
  assetType: import("../../..").AssetType;
815
835
  pricePerUnit: number | null;
@@ -827,15 +847,18 @@ export declare const offeringsContract: {
827
847
  hasEscrow?: boolean | undefined;
828
848
  bankAccountId?: string | null | undefined;
829
849
  escrowAccountId?: string | null | undefined;
850
+ totalShares?: number | null | undefined;
851
+ warrantTermYears?: number | null | undefined;
852
+ exercisePrice?: number | null | undefined;
853
+ warrantPercentage?: number | null | undefined;
854
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
855
+ incrementThreshold?: number | null | undefined;
830
856
  yield?: number | null | undefined;
831
857
  duration?: number | null | undefined;
832
858
  durationType?: import("../../..").DurationType | null | undefined;
833
859
  tiers?: number[] | null | undefined;
834
860
  enableBonus?: boolean | undefined;
835
- principalAmount?: number | null | undefined;
836
- maxTotalRaise?: number | null | undefined;
837
861
  interestRate?: number | null | undefined;
838
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
839
862
  bonusTiers?: {
840
863
  value: number;
841
864
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -865,15 +888,19 @@ export declare const offeringsContract: {
865
888
  hasEscrow?: boolean | undefined;
866
889
  bankAccountId?: string | null | undefined;
867
890
  escrowAccountId?: string | null | undefined;
891
+ warrantsEnabled?: boolean | undefined;
892
+ totalShares?: number | null | undefined;
893
+ warrantTermYears?: number | null | undefined;
894
+ exercisePrice?: number | null | undefined;
895
+ warrantPercentage?: number | null | undefined;
896
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
897
+ incrementThreshold?: number | null | undefined;
868
898
  yield?: number | null | undefined;
869
899
  duration?: number | null | undefined;
870
900
  durationType?: import("../../..").DurationType | null | undefined;
871
901
  tiers?: number[] | null | undefined;
872
902
  enableBonus?: boolean | undefined;
873
- principalAmount?: number | null | undefined;
874
- maxTotalRaise?: number | null | undefined;
875
903
  interestRate?: number | null | undefined;
876
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
877
904
  bonusTiers?: {
878
905
  value: number;
879
906
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -886,6 +913,7 @@ export declare const offeringsContract: {
886
913
  template: import("../../../common/types/asset.types").AssetTemplateType;
887
914
  targetAmount: number;
888
915
  issuerId: string;
916
+ warrantsEnabled: boolean;
889
917
  assetName: string;
890
918
  assetType: import("../../..").AssetType;
891
919
  pricePerUnit: number | null;
@@ -903,15 +931,18 @@ export declare const offeringsContract: {
903
931
  hasEscrow?: boolean | undefined;
904
932
  bankAccountId?: string | null | undefined;
905
933
  escrowAccountId?: string | null | undefined;
934
+ totalShares?: number | null | undefined;
935
+ warrantTermYears?: number | null | undefined;
936
+ exercisePrice?: number | null | undefined;
937
+ warrantPercentage?: number | null | undefined;
938
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
939
+ incrementThreshold?: number | null | undefined;
906
940
  yield?: number | null | undefined;
907
941
  duration?: number | null | undefined;
908
942
  durationType?: import("../../..").DurationType | null | undefined;
909
943
  tiers?: number[] | null | undefined;
910
944
  enableBonus?: boolean | undefined;
911
- principalAmount?: number | null | undefined;
912
- maxTotalRaise?: number | null | undefined;
913
945
  interestRate?: number | null | undefined;
914
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
915
946
  bonusTiers?: {
916
947
  value: number;
917
948
  type: import("../../../common/types/bonus-tier.types").BonusType;
@@ -941,15 +972,19 @@ export declare const offeringsContract: {
941
972
  hasEscrow?: boolean | undefined;
942
973
  bankAccountId?: string | null | undefined;
943
974
  escrowAccountId?: string | null | undefined;
975
+ warrantsEnabled?: boolean | undefined;
976
+ totalShares?: number | null | undefined;
977
+ warrantTermYears?: number | null | undefined;
978
+ exercisePrice?: number | null | undefined;
979
+ warrantPercentage?: number | null | undefined;
980
+ calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
981
+ incrementThreshold?: number | null | undefined;
944
982
  yield?: number | null | undefined;
945
983
  duration?: number | null | undefined;
946
984
  durationType?: import("../../..").DurationType | null | undefined;
947
985
  tiers?: number[] | null | undefined;
948
986
  enableBonus?: boolean | undefined;
949
- principalAmount?: number | null | undefined;
950
- maxTotalRaise?: number | null | undefined;
951
987
  interestRate?: number | null | undefined;
952
- interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
953
988
  bonusTiers?: {
954
989
  value: number;
955
990
  type: import("../../../common/types/bonus-tier.types").BonusType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dalmore/api-contracts",
3
- "version": "0.0.0-dev.2982281",
3
+ "version": "0.0.0-dev.2cea8e5",
4
4
  "description": "Type-safe API contracts for Dalmore Client Portal",
5
5
  "type": "module",
6
6
  "main": "./index.js",