@dalmore/api-contracts 0.0.0-dev.ada6a86 → 0.0.0-dev.b23d491

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 (52) hide show
  1. package/common/types/activity.types.d.ts +27 -24
  2. package/common/types/activity.types.js +6 -0
  3. package/common/types/activity.types.js.map +1 -1
  4. package/common/types/asset.types.d.ts +298 -0
  5. package/common/types/asset.types.js +191 -42
  6. package/common/types/asset.types.js.map +1 -1
  7. package/common/types/bonus-tier.types.d.ts +41 -0
  8. package/common/types/bonus-tier.types.js +14 -7
  9. package/common/types/bonus-tier.types.js.map +1 -1
  10. package/common/types/common.types.d.ts +27 -3
  11. package/common/types/common.types.js +17 -0
  12. package/common/types/common.types.js.map +1 -1
  13. package/common/types/comply-advantage-api.types.d.ts +133 -466
  14. package/common/types/comply-advantage-api.types.js +24 -3
  15. package/common/types/comply-advantage-api.types.js.map +1 -1
  16. package/common/types/dashboard.types.d.ts +7 -7
  17. package/common/types/data-record.types.d.ts +4 -4
  18. package/common/types/disbursements.types.d.ts +106 -626
  19. package/common/types/disbursements.types.js +3 -0
  20. package/common/types/disbursements.types.js.map +1 -1
  21. package/common/types/escrow-account.types.d.ts +17 -0
  22. package/common/types/escrow-account.types.js +3 -0
  23. package/common/types/escrow-account.types.js.map +1 -1
  24. package/common/types/file.types.d.ts +14 -11
  25. package/common/types/file.types.js +2 -0
  26. package/common/types/file.types.js.map +1 -1
  27. package/common/types/individuals.types.js +5 -2
  28. package/common/types/individuals.types.js.map +1 -1
  29. package/common/types/issuer-bank-account.types.d.ts +4 -276
  30. package/common/types/issuer-offering.types.d.ts +729 -6
  31. package/common/types/issuer-offering.types.js +141 -5
  32. package/common/types/issuer-offering.types.js.map +1 -1
  33. package/common/types/job-item.types.d.ts +14 -14
  34. package/common/types/note.types.d.ts +15 -15
  35. package/common/types/offering.types.d.ts +321 -2
  36. package/common/types/offering.types.js +152 -11
  37. package/common/types/offering.types.js.map +1 -1
  38. package/common/types/signer.types.d.ts +8 -8
  39. package/common/types/site.types.d.ts +20 -0
  40. package/common/types/task.types.d.ts +22 -22
  41. package/common/types/trade.types.d.ts +2 -0
  42. package/common/types/trade.types.js +2 -0
  43. package/common/types/trade.types.js.map +1 -1
  44. package/common/types/transaction.types.d.ts +80 -1
  45. package/common/types/transaction.types.js +22 -2
  46. package/common/types/transaction.types.js.map +1 -1
  47. package/contracts/clients/assets/index.d.ts +88 -0
  48. package/contracts/clients/files/index.d.ts +3 -3
  49. package/contracts/clients/files-public/index.d.ts +3 -3
  50. package/contracts/clients/index.d.ts +344 -10
  51. package/contracts/clients/offerings/index.d.ts +250 -4
  52. package/package.json +1 -1
package/contracts/clients/offerings/index.d.ts CHANGED
@@ -412,7 +412,7 @@ export declare const offeringsContract: {
412
412
  metadata: {
413
413
  auth: boolean;
414
414
  };
415
- body: z.ZodObject<{
415
+ body: z.ZodEffects<z.ZodObject<{
416
416
  name: z.ZodOptional<z.ZodString>;
417
417
  type: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").OfferingType>>;
418
418
  targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -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>;
@@ -440,10 +439,53 @@ export declare const offeringsContract: {
440
439
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
441
440
  enabled: z.ZodOptional<z.ZodBoolean>;
442
441
  enableBonus: z.ZodOptional<z.ZodBoolean>;
442
+ hasEscrow: z.ZodOptional<z.ZodBoolean>;
443
+ escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
444
+ bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
445
+ escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
446
+ principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
447
+ maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
448
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
449
+ interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
450
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
451
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
452
+ value: z.ZodEffects<z.ZodNumber, number, number>;
453
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
454
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
455
+ }, "strip", z.ZodTypeAny, {
456
+ value: number;
457
+ type: import("../../../common/types/bonus-tier.types").BonusType;
458
+ startAmount: number;
459
+ endAmount: number;
460
+ }, {
461
+ value: number;
462
+ type: import("../../../common/types/bonus-tier.types").BonusType;
463
+ startAmount: number;
464
+ endAmount: number;
465
+ }>, {
466
+ value: number;
467
+ type: import("../../../common/types/bonus-tier.types").BonusType;
468
+ startAmount: number;
469
+ endAmount: number;
470
+ }, {
471
+ value: number;
472
+ type: import("../../../common/types/bonus-tier.types").BonusType;
473
+ startAmount: number;
474
+ endAmount: number;
475
+ }>, {
476
+ value: number;
477
+ type: import("../../../common/types/bonus-tier.types").BonusType;
478
+ startAmount: number;
479
+ endAmount: number;
480
+ }, {
481
+ value: number;
482
+ type: import("../../../common/types/bonus-tier.types").BonusType;
483
+ startAmount: number;
484
+ endAmount: number;
485
+ }>, "many">>;
443
486
  }, "strip", z.ZodTypeAny, {
444
487
  type?: import("../../..").OfferingType | undefined;
445
488
  name?: string | undefined;
446
- managedBy?: import("../../..").ManagedByType | undefined;
447
489
  description?: string | null | undefined;
448
490
  enabled?: boolean | undefined;
449
491
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -459,6 +501,10 @@ export declare const offeringsContract: {
459
501
  memorandumId?: string | null | undefined;
460
502
  subscriptionAgreementId?: string | null | undefined;
461
503
  showTotalRaised?: boolean | undefined;
504
+ hasEscrow?: boolean | undefined;
505
+ escrowAgreementFileId?: string | null | undefined;
506
+ bankAccountId?: string | null | undefined;
507
+ escrowAccountId?: string | null | undefined;
462
508
  assetName?: string | undefined;
463
509
  assetType?: import("../../..").AssetType | undefined;
464
510
  pricePerUnit?: number | null | undefined;
@@ -468,10 +514,19 @@ export declare const offeringsContract: {
468
514
  durationType?: import("../../..").DurationType | null | undefined;
469
515
  tiers?: number[] | null | undefined;
470
516
  enableBonus?: boolean | undefined;
517
+ principalAmount?: number | null | undefined;
518
+ maxTotalRaise?: number | null | undefined;
519
+ interestRate?: number | null | undefined;
520
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
521
+ bonusTiers?: {
522
+ value: number;
523
+ type: import("../../../common/types/bonus-tier.types").BonusType;
524
+ startAmount: number;
525
+ endAmount: number;
526
+ }[] | undefined;
471
527
  }, {
472
528
  type?: import("../../..").OfferingType | undefined;
473
529
  name?: string | undefined;
474
- managedBy?: import("../../..").ManagedByType | undefined;
475
530
  description?: string | null | undefined;
476
531
  enabled?: boolean | undefined;
477
532
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -487,6 +542,92 @@ export declare const offeringsContract: {
487
542
  memorandumId?: string | null | undefined;
488
543
  subscriptionAgreementId?: string | null | undefined;
489
544
  showTotalRaised?: boolean | undefined;
545
+ hasEscrow?: boolean | undefined;
546
+ escrowAgreementFileId?: string | null | undefined;
547
+ bankAccountId?: string | null | undefined;
548
+ escrowAccountId?: string | null | undefined;
549
+ assetName?: string | undefined;
550
+ assetType?: import("../../..").AssetType | undefined;
551
+ pricePerUnit?: number | null | undefined;
552
+ totalUnits?: number | null | undefined;
553
+ yield?: number | null | undefined;
554
+ duration?: number | null | undefined;
555
+ durationType?: import("../../..").DurationType | null | undefined;
556
+ tiers?: number[] | null | undefined;
557
+ enableBonus?: boolean | undefined;
558
+ principalAmount?: number | null | undefined;
559
+ maxTotalRaise?: number | null | undefined;
560
+ interestRate?: number | null | undefined;
561
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
562
+ bonusTiers?: {
563
+ value: number;
564
+ type: import("../../../common/types/bonus-tier.types").BonusType;
565
+ startAmount: number;
566
+ endAmount: number;
567
+ }[] | undefined;
568
+ }>, {
569
+ type?: import("../../..").OfferingType | undefined;
570
+ name?: string | undefined;
571
+ description?: string | null | undefined;
572
+ enabled?: boolean | undefined;
573
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
574
+ coverArtId?: string | null | undefined;
575
+ targetAmount?: number | undefined;
576
+ minInvestment?: number | null | undefined;
577
+ maxInvestment?: number | null | undefined;
578
+ contingencyAmount?: number | null | undefined;
579
+ startAt?: Date | null | undefined;
580
+ endAt?: Date | null | undefined;
581
+ issuerId?: string | undefined;
582
+ cancellationPeriod?: number | null | undefined;
583
+ memorandumId?: string | null | undefined;
584
+ subscriptionAgreementId?: string | null | undefined;
585
+ showTotalRaised?: boolean | undefined;
586
+ hasEscrow?: boolean | undefined;
587
+ escrowAgreementFileId?: string | null | undefined;
588
+ bankAccountId?: string | null | undefined;
589
+ escrowAccountId?: string | null | undefined;
590
+ assetName?: string | undefined;
591
+ assetType?: import("../../..").AssetType | undefined;
592
+ pricePerUnit?: number | null | undefined;
593
+ totalUnits?: number | null | undefined;
594
+ yield?: number | null | undefined;
595
+ duration?: number | null | undefined;
596
+ durationType?: import("../../..").DurationType | null | undefined;
597
+ tiers?: number[] | null | undefined;
598
+ enableBonus?: boolean | undefined;
599
+ principalAmount?: number | null | undefined;
600
+ maxTotalRaise?: number | null | undefined;
601
+ interestRate?: number | null | undefined;
602
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
603
+ bonusTiers?: {
604
+ value: number;
605
+ type: import("../../../common/types/bonus-tier.types").BonusType;
606
+ startAmount: number;
607
+ endAmount: number;
608
+ }[] | undefined;
609
+ }, {
610
+ type?: import("../../..").OfferingType | undefined;
611
+ name?: string | undefined;
612
+ description?: string | null | undefined;
613
+ enabled?: boolean | undefined;
614
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
615
+ coverArtId?: string | null | undefined;
616
+ targetAmount?: number | undefined;
617
+ minInvestment?: number | null | undefined;
618
+ maxInvestment?: number | null | undefined;
619
+ contingencyAmount?: number | null | undefined;
620
+ startAt?: string | null | undefined;
621
+ endAt?: string | null | undefined;
622
+ issuerId?: string | undefined;
623
+ cancellationPeriod?: number | null | undefined;
624
+ memorandumId?: string | null | undefined;
625
+ subscriptionAgreementId?: string | null | undefined;
626
+ showTotalRaised?: boolean | undefined;
627
+ hasEscrow?: boolean | undefined;
628
+ escrowAgreementFileId?: string | null | undefined;
629
+ bankAccountId?: string | null | undefined;
630
+ escrowAccountId?: string | null | undefined;
490
631
  assetName?: string | undefined;
491
632
  assetType?: import("../../..").AssetType | undefined;
492
633
  pricePerUnit?: number | null | undefined;
@@ -496,6 +637,16 @@ export declare const offeringsContract: {
496
637
  durationType?: import("../../..").DurationType | null | undefined;
497
638
  tiers?: number[] | null | undefined;
498
639
  enableBonus?: boolean | undefined;
640
+ principalAmount?: number | null | undefined;
641
+ maxTotalRaise?: number | null | undefined;
642
+ interestRate?: number | null | undefined;
643
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
644
+ bonusTiers?: {
645
+ value: number;
646
+ type: import("../../../common/types/bonus-tier.types").BonusType;
647
+ startAmount: number;
648
+ endAmount: number;
649
+ }[] | undefined;
499
650
  }>;
500
651
  pathParams: z.ZodObject<{
501
652
  id: z.ZodEffects<z.ZodString, string, string>;
@@ -605,6 +756,49 @@ export declare const offeringsContract: {
605
756
  template: z.ZodDefault<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").AssetTemplateType>>;
606
757
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
607
758
  enableBonus: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
759
+ hasEscrow: z.ZodOptional<z.ZodBoolean>;
760
+ bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
761
+ escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
762
+ principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
763
+ maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
764
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
765
+ interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
766
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
767
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
768
+ value: z.ZodEffects<z.ZodNumber, number, number>;
769
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
770
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
771
+ }, "strip", z.ZodTypeAny, {
772
+ value: number;
773
+ type: import("../../../common/types/bonus-tier.types").BonusType;
774
+ startAmount: number;
775
+ endAmount: number;
776
+ }, {
777
+ value: number;
778
+ type: import("../../../common/types/bonus-tier.types").BonusType;
779
+ startAmount: number;
780
+ endAmount: number;
781
+ }>, {
782
+ value: number;
783
+ type: import("../../../common/types/bonus-tier.types").BonusType;
784
+ startAmount: number;
785
+ endAmount: number;
786
+ }, {
787
+ value: number;
788
+ type: import("../../../common/types/bonus-tier.types").BonusType;
789
+ startAmount: number;
790
+ endAmount: number;
791
+ }>, {
792
+ value: number;
793
+ type: import("../../../common/types/bonus-tier.types").BonusType;
794
+ startAmount: number;
795
+ endAmount: number;
796
+ }, {
797
+ value: number;
798
+ type: import("../../../common/types/bonus-tier.types").BonusType;
799
+ startAmount: number;
800
+ endAmount: number;
801
+ }>, "many">>;
608
802
  }, "strip", z.ZodTypeAny, {
609
803
  type: import("../../..").OfferingType;
610
804
  name: string;
@@ -625,11 +819,24 @@ export declare const offeringsContract: {
625
819
  startAt?: Date | null | undefined;
626
820
  endAt?: Date | null | undefined;
627
821
  cancellationPeriod?: number | null | undefined;
822
+ hasEscrow?: boolean | undefined;
823
+ bankAccountId?: string | null | undefined;
824
+ escrowAccountId?: string | null | undefined;
628
825
  yield?: number | null | undefined;
629
826
  duration?: number | null | undefined;
630
827
  durationType?: import("../../..").DurationType | null | undefined;
631
828
  tiers?: number[] | null | undefined;
632
829
  enableBonus?: boolean | undefined;
830
+ principalAmount?: number | null | undefined;
831
+ maxTotalRaise?: number | null | undefined;
832
+ interestRate?: number | null | undefined;
833
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
834
+ bonusTiers?: {
835
+ value: number;
836
+ type: import("../../../common/types/bonus-tier.types").BonusType;
837
+ startAmount: number;
838
+ endAmount: number;
839
+ }[] | undefined;
633
840
  }, {
634
841
  type: import("../../..").OfferingType;
635
842
  name: string;
@@ -650,11 +857,24 @@ export declare const offeringsContract: {
650
857
  startAt?: string | null | undefined;
651
858
  endAt?: string | null | undefined;
652
859
  cancellationPeriod?: number | null | undefined;
860
+ hasEscrow?: boolean | undefined;
861
+ bankAccountId?: string | null | undefined;
862
+ escrowAccountId?: string | null | undefined;
653
863
  yield?: number | null | undefined;
654
864
  duration?: number | null | undefined;
655
865
  durationType?: import("../../..").DurationType | null | undefined;
656
866
  tiers?: number[] | null | undefined;
657
867
  enableBonus?: boolean | undefined;
868
+ principalAmount?: number | null | undefined;
869
+ maxTotalRaise?: number | null | undefined;
870
+ interestRate?: number | null | undefined;
871
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
872
+ bonusTiers?: {
873
+ value: number;
874
+ type: import("../../../common/types/bonus-tier.types").BonusType;
875
+ startAmount: number;
876
+ endAmount: number;
877
+ }[] | undefined;
658
878
  }>, {
659
879
  type: import("../../..").OfferingType;
660
880
  name: string;
@@ -675,11 +895,24 @@ export declare const offeringsContract: {
675
895
  startAt?: Date | null | undefined;
676
896
  endAt?: Date | null | undefined;
677
897
  cancellationPeriod?: number | null | undefined;
898
+ hasEscrow?: boolean | undefined;
899
+ bankAccountId?: string | null | undefined;
900
+ escrowAccountId?: string | null | undefined;
678
901
  yield?: number | null | undefined;
679
902
  duration?: number | null | undefined;
680
903
  durationType?: import("../../..").DurationType | null | undefined;
681
904
  tiers?: number[] | null | undefined;
682
905
  enableBonus?: boolean | undefined;
906
+ principalAmount?: number | null | undefined;
907
+ maxTotalRaise?: number | null | undefined;
908
+ interestRate?: number | null | undefined;
909
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
910
+ bonusTiers?: {
911
+ value: number;
912
+ type: import("../../../common/types/bonus-tier.types").BonusType;
913
+ startAmount: number;
914
+ endAmount: number;
915
+ }[] | undefined;
683
916
  }, {
684
917
  type: import("../../..").OfferingType;
685
918
  name: string;
@@ -700,11 +933,24 @@ export declare const offeringsContract: {
700
933
  startAt?: string | null | undefined;
701
934
  endAt?: string | null | undefined;
702
935
  cancellationPeriod?: number | null | undefined;
936
+ hasEscrow?: boolean | undefined;
937
+ bankAccountId?: string | null | undefined;
938
+ escrowAccountId?: string | null | undefined;
703
939
  yield?: number | null | undefined;
704
940
  duration?: number | null | undefined;
705
941
  durationType?: import("../../..").DurationType | null | undefined;
706
942
  tiers?: number[] | null | undefined;
707
943
  enableBonus?: boolean | undefined;
944
+ principalAmount?: number | null | undefined;
945
+ maxTotalRaise?: number | null | undefined;
946
+ interestRate?: number | null | undefined;
947
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
948
+ bonusTiers?: {
949
+ value: number;
950
+ type: import("../../../common/types/bonus-tier.types").BonusType;
951
+ startAmount: number;
952
+ endAmount: number;
953
+ }[] | undefined;
708
954
  }>;
709
955
  summary: "[ADMIN] Create offering";
710
956
  path: "offerings";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dalmore/api-contracts",
3
- "version": "0.0.0-dev.ada6a86",
3
+ "version": "0.0.0-dev.b23d491",
4
4
  "description": "Type-safe API contracts for Dalmore Client Portal",
5
5
  "type": "module",
6
6
  "main": "./index.js",