@dalmore/api-contracts 0.0.0-dev.685c0b3 → 0.0.0-dev.6f65580

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 (65) hide show
  1. package/common/types/account-setting.types.d.ts +64 -0
  2. package/common/types/account-setting.types.js +8 -0
  3. package/common/types/account-setting.types.js.map +1 -1
  4. package/common/types/account.types.d.ts +38 -2
  5. package/common/types/account.types.js +3 -0
  6. package/common/types/account.types.js.map +1 -1
  7. package/common/types/activity.types.d.ts +25 -24
  8. package/common/types/activity.types.js +2 -0
  9. package/common/types/activity.types.js.map +1 -1
  10. package/common/types/asset.types.d.ts +298 -0
  11. package/common/types/asset.types.js +191 -42
  12. package/common/types/asset.types.js.map +1 -1
  13. package/common/types/auth.types.d.ts +1 -1
  14. package/common/types/auth.types.js +1 -1
  15. package/common/types/auth.types.js.map +1 -1
  16. package/common/types/bonus-tier.types.d.ts +45 -4
  17. package/common/types/bonus-tier.types.js +14 -7
  18. package/common/types/bonus-tier.types.js.map +1 -1
  19. package/common/types/cap-table.types.d.ts +8 -8
  20. package/common/types/common.types.d.ts +19 -2
  21. package/common/types/common.types.js +12 -0
  22. package/common/types/common.types.js.map +1 -1
  23. package/common/types/comply-advantage-api.types.d.ts +133 -466
  24. package/common/types/comply-advantage-api.types.js +24 -3
  25. package/common/types/comply-advantage-api.types.js.map +1 -1
  26. package/common/types/dashboard.types.d.ts +7 -7
  27. package/common/types/data-record.types.d.ts +4 -4
  28. package/common/types/disbursements.types.d.ts +596 -392
  29. package/common/types/disbursements.types.js +37 -0
  30. package/common/types/disbursements.types.js.map +1 -1
  31. package/common/types/file.types.d.ts +9 -9
  32. package/common/types/investor-account.types.d.ts +4 -4
  33. package/common/types/issuer-bank-account.types.d.ts +4 -276
  34. package/common/types/issuer-offering.types.d.ts +719 -3
  35. package/common/types/issuer-offering.types.js +139 -4
  36. package/common/types/issuer-offering.types.js.map +1 -1
  37. package/common/types/job-item.types.d.ts +14 -14
  38. package/common/types/note.types.d.ts +15 -15
  39. package/common/types/offering.types.d.ts +320 -1
  40. package/common/types/offering.types.js +150 -11
  41. package/common/types/offering.types.js.map +1 -1
  42. package/common/types/signer.types.d.ts +23 -11
  43. package/common/types/signer.types.js +16 -1
  44. package/common/types/signer.types.js.map +1 -1
  45. package/common/types/site.types.d.ts +20 -0
  46. package/common/types/task.types.d.ts +22 -22
  47. package/common/types/trade-line-item.types.d.ts +18 -1
  48. package/common/types/trade-line-item.types.js +12 -1
  49. package/common/types/trade-line-item.types.js.map +1 -1
  50. package/common/types/trade.types.d.ts +62 -45
  51. package/common/types/trade.types.js +11 -4
  52. package/common/types/trade.types.js.map +1 -1
  53. package/common/types/transaction.types.d.ts +80 -1
  54. package/common/types/transaction.types.js +22 -2
  55. package/common/types/transaction.types.js.map +1 -1
  56. package/common/types/user.types.d.ts +5 -0
  57. package/common/types/user.types.js +1 -0
  58. package/common/types/user.types.js.map +1 -1
  59. package/contracts/clients/assets/index.d.ts +88 -0
  60. package/contracts/clients/files/index.d.ts +3 -3
  61. package/contracts/clients/files-public/index.d.ts +3 -3
  62. package/contracts/clients/index.d.ts +355 -10
  63. package/contracts/clients/offerings/index.d.ts +252 -1
  64. package/contracts/clients/trades/index.d.ts +9 -3
  65. 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>;
@@ -440,6 +440,50 @@ export declare const offeringsContract: {
440
440
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
441
441
  enabled: z.ZodOptional<z.ZodBoolean>;
442
442
  enableBonus: z.ZodOptional<z.ZodBoolean>;
443
+ hasEscrow: z.ZodOptional<z.ZodBoolean>;
444
+ escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
445
+ bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
446
+ 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
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
450
+ interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
451
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
452
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
453
+ value: z.ZodEffects<z.ZodNumber, number, number>;
454
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
455
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
456
+ }, "strip", z.ZodTypeAny, {
457
+ value: number;
458
+ type: import("../../../common/types/bonus-tier.types").BonusType;
459
+ startAmount: number;
460
+ endAmount: number;
461
+ }, {
462
+ value: number;
463
+ type: import("../../../common/types/bonus-tier.types").BonusType;
464
+ startAmount: number;
465
+ endAmount: number;
466
+ }>, {
467
+ value: number;
468
+ type: import("../../../common/types/bonus-tier.types").BonusType;
469
+ startAmount: number;
470
+ endAmount: number;
471
+ }, {
472
+ value: number;
473
+ type: import("../../../common/types/bonus-tier.types").BonusType;
474
+ startAmount: number;
475
+ endAmount: number;
476
+ }>, {
477
+ value: number;
478
+ type: import("../../../common/types/bonus-tier.types").BonusType;
479
+ startAmount: number;
480
+ endAmount: number;
481
+ }, {
482
+ value: number;
483
+ type: import("../../../common/types/bonus-tier.types").BonusType;
484
+ startAmount: number;
485
+ endAmount: number;
486
+ }>, "many">>;
443
487
  }, "strip", z.ZodTypeAny, {
444
488
  type?: import("../../..").OfferingType | undefined;
445
489
  name?: string | undefined;
@@ -459,6 +503,10 @@ export declare const offeringsContract: {
459
503
  memorandumId?: string | null | undefined;
460
504
  subscriptionAgreementId?: string | null | undefined;
461
505
  showTotalRaised?: boolean | undefined;
506
+ hasEscrow?: boolean | undefined;
507
+ escrowAgreementFileId?: string | null | undefined;
508
+ bankAccountId?: string | null | undefined;
509
+ escrowAccountId?: string | null | undefined;
462
510
  assetName?: string | undefined;
463
511
  assetType?: import("../../..").AssetType | undefined;
464
512
  pricePerUnit?: number | null | undefined;
@@ -468,6 +516,16 @@ export declare const offeringsContract: {
468
516
  durationType?: import("../../..").DurationType | null | undefined;
469
517
  tiers?: number[] | null | undefined;
470
518
  enableBonus?: boolean | undefined;
519
+ principalAmount?: number | null | undefined;
520
+ maxTotalRaise?: number | null | undefined;
521
+ interestRate?: number | null | undefined;
522
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
523
+ bonusTiers?: {
524
+ value: number;
525
+ type: import("../../../common/types/bonus-tier.types").BonusType;
526
+ startAmount: number;
527
+ endAmount: number;
528
+ }[] | undefined;
471
529
  }, {
472
530
  type?: import("../../..").OfferingType | undefined;
473
531
  name?: string | undefined;
@@ -487,6 +545,52 @@ export declare const offeringsContract: {
487
545
  memorandumId?: string | null | undefined;
488
546
  subscriptionAgreementId?: string | null | undefined;
489
547
  showTotalRaised?: boolean | undefined;
548
+ hasEscrow?: boolean | undefined;
549
+ escrowAgreementFileId?: string | null | undefined;
550
+ bankAccountId?: string | null | undefined;
551
+ escrowAccountId?: string | null | undefined;
552
+ assetName?: string | undefined;
553
+ assetType?: import("../../..").AssetType | undefined;
554
+ pricePerUnit?: number | null | undefined;
555
+ totalUnits?: number | null | undefined;
556
+ yield?: number | null | undefined;
557
+ duration?: number | null | undefined;
558
+ durationType?: import("../../..").DurationType | null | undefined;
559
+ tiers?: number[] | null | undefined;
560
+ enableBonus?: boolean | undefined;
561
+ principalAmount?: number | null | undefined;
562
+ maxTotalRaise?: number | null | undefined;
563
+ interestRate?: number | null | undefined;
564
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
565
+ bonusTiers?: {
566
+ value: number;
567
+ type: import("../../../common/types/bonus-tier.types").BonusType;
568
+ startAmount: number;
569
+ endAmount: number;
570
+ }[] | undefined;
571
+ }>, {
572
+ type?: import("../../..").OfferingType | undefined;
573
+ name?: string | undefined;
574
+ managedBy?: import("../../..").ManagedByType | undefined;
575
+ description?: string | null | undefined;
576
+ enabled?: boolean | undefined;
577
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
578
+ coverArtId?: string | null | undefined;
579
+ targetAmount?: number | undefined;
580
+ minInvestment?: number | null | undefined;
581
+ maxInvestment?: number | null | undefined;
582
+ contingencyAmount?: number | null | undefined;
583
+ startAt?: Date | null | undefined;
584
+ endAt?: Date | null | undefined;
585
+ issuerId?: string | undefined;
586
+ cancellationPeriod?: number | null | undefined;
587
+ memorandumId?: string | null | undefined;
588
+ subscriptionAgreementId?: string | null | undefined;
589
+ showTotalRaised?: boolean | undefined;
590
+ hasEscrow?: boolean | undefined;
591
+ escrowAgreementFileId?: string | null | undefined;
592
+ bankAccountId?: string | null | undefined;
593
+ escrowAccountId?: string | null | undefined;
490
594
  assetName?: string | undefined;
491
595
  assetType?: import("../../..").AssetType | undefined;
492
596
  pricePerUnit?: number | null | undefined;
@@ -496,6 +600,58 @@ export declare const offeringsContract: {
496
600
  durationType?: import("../../..").DurationType | null | undefined;
497
601
  tiers?: number[] | null | undefined;
498
602
  enableBonus?: boolean | undefined;
603
+ principalAmount?: number | null | undefined;
604
+ maxTotalRaise?: number | null | undefined;
605
+ interestRate?: number | null | undefined;
606
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
607
+ bonusTiers?: {
608
+ value: number;
609
+ type: import("../../../common/types/bonus-tier.types").BonusType;
610
+ startAmount: number;
611
+ endAmount: number;
612
+ }[] | undefined;
613
+ }, {
614
+ type?: import("../../..").OfferingType | undefined;
615
+ name?: string | undefined;
616
+ managedBy?: import("../../..").ManagedByType | undefined;
617
+ description?: string | null | undefined;
618
+ enabled?: boolean | undefined;
619
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
620
+ coverArtId?: string | null | undefined;
621
+ targetAmount?: number | undefined;
622
+ minInvestment?: number | null | undefined;
623
+ maxInvestment?: number | null | undefined;
624
+ contingencyAmount?: number | null | undefined;
625
+ startAt?: string | null | undefined;
626
+ endAt?: string | null | undefined;
627
+ issuerId?: string | undefined;
628
+ cancellationPeriod?: number | null | undefined;
629
+ memorandumId?: string | null | undefined;
630
+ subscriptionAgreementId?: string | null | undefined;
631
+ showTotalRaised?: boolean | undefined;
632
+ hasEscrow?: boolean | undefined;
633
+ escrowAgreementFileId?: string | null | undefined;
634
+ bankAccountId?: string | null | undefined;
635
+ escrowAccountId?: string | null | undefined;
636
+ assetName?: string | undefined;
637
+ assetType?: import("../../..").AssetType | undefined;
638
+ pricePerUnit?: number | null | undefined;
639
+ totalUnits?: number | null | undefined;
640
+ yield?: number | null | undefined;
641
+ duration?: number | null | undefined;
642
+ durationType?: import("../../..").DurationType | null | undefined;
643
+ tiers?: number[] | null | undefined;
644
+ enableBonus?: boolean | undefined;
645
+ principalAmount?: number | null | undefined;
646
+ maxTotalRaise?: number | null | undefined;
647
+ interestRate?: number | null | undefined;
648
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
649
+ bonusTiers?: {
650
+ value: number;
651
+ type: import("../../../common/types/bonus-tier.types").BonusType;
652
+ startAmount: number;
653
+ endAmount: number;
654
+ }[] | undefined;
499
655
  }>;
500
656
  pathParams: z.ZodObject<{
501
657
  id: z.ZodEffects<z.ZodString, string, string>;
@@ -605,6 +761,49 @@ export declare const offeringsContract: {
605
761
  template: z.ZodDefault<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").AssetTemplateType>>;
606
762
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
607
763
  enableBonus: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
764
+ hasEscrow: z.ZodOptional<z.ZodBoolean>;
765
+ bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
766
+ 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
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
770
+ interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").InterestType>>>;
771
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
772
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
773
+ value: z.ZodEffects<z.ZodNumber, number, number>;
774
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
775
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
776
+ }, "strip", z.ZodTypeAny, {
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
+ }, {
802
+ value: number;
803
+ type: import("../../../common/types/bonus-tier.types").BonusType;
804
+ startAmount: number;
805
+ endAmount: number;
806
+ }>, "many">>;
608
807
  }, "strip", z.ZodTypeAny, {
609
808
  type: import("../../..").OfferingType;
610
809
  name: string;
@@ -625,11 +824,24 @@ export declare const offeringsContract: {
625
824
  startAt?: Date | null | undefined;
626
825
  endAt?: Date | null | undefined;
627
826
  cancellationPeriod?: number | null | undefined;
827
+ hasEscrow?: boolean | undefined;
828
+ bankAccountId?: string | null | undefined;
829
+ escrowAccountId?: string | null | undefined;
628
830
  yield?: number | null | undefined;
629
831
  duration?: number | null | undefined;
630
832
  durationType?: import("../../..").DurationType | null | undefined;
631
833
  tiers?: number[] | null | undefined;
632
834
  enableBonus?: boolean | undefined;
835
+ principalAmount?: number | null | undefined;
836
+ maxTotalRaise?: number | null | undefined;
837
+ interestRate?: number | null | undefined;
838
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
839
+ bonusTiers?: {
840
+ value: number;
841
+ type: import("../../../common/types/bonus-tier.types").BonusType;
842
+ startAmount: number;
843
+ endAmount: number;
844
+ }[] | undefined;
633
845
  }, {
634
846
  type: import("../../..").OfferingType;
635
847
  name: string;
@@ -650,11 +862,24 @@ export declare const offeringsContract: {
650
862
  startAt?: string | null | undefined;
651
863
  endAt?: string | null | undefined;
652
864
  cancellationPeriod?: number | null | undefined;
865
+ hasEscrow?: boolean | undefined;
866
+ bankAccountId?: string | null | undefined;
867
+ escrowAccountId?: string | null | undefined;
653
868
  yield?: number | null | undefined;
654
869
  duration?: number | null | undefined;
655
870
  durationType?: import("../../..").DurationType | null | undefined;
656
871
  tiers?: number[] | null | undefined;
657
872
  enableBonus?: boolean | undefined;
873
+ principalAmount?: number | null | undefined;
874
+ maxTotalRaise?: number | null | undefined;
875
+ interestRate?: number | null | undefined;
876
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
877
+ bonusTiers?: {
878
+ value: number;
879
+ type: import("../../../common/types/bonus-tier.types").BonusType;
880
+ startAmount: number;
881
+ endAmount: number;
882
+ }[] | undefined;
658
883
  }>, {
659
884
  type: import("../../..").OfferingType;
660
885
  name: string;
@@ -675,11 +900,24 @@ export declare const offeringsContract: {
675
900
  startAt?: Date | null | undefined;
676
901
  endAt?: Date | null | undefined;
677
902
  cancellationPeriod?: number | null | undefined;
903
+ hasEscrow?: boolean | undefined;
904
+ bankAccountId?: string | null | undefined;
905
+ escrowAccountId?: string | null | undefined;
678
906
  yield?: number | null | undefined;
679
907
  duration?: number | null | undefined;
680
908
  durationType?: import("../../..").DurationType | null | undefined;
681
909
  tiers?: number[] | null | undefined;
682
910
  enableBonus?: boolean | undefined;
911
+ principalAmount?: number | null | undefined;
912
+ maxTotalRaise?: number | null | undefined;
913
+ interestRate?: number | null | undefined;
914
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
915
+ bonusTiers?: {
916
+ value: number;
917
+ type: import("../../../common/types/bonus-tier.types").BonusType;
918
+ startAmount: number;
919
+ endAmount: number;
920
+ }[] | undefined;
683
921
  }, {
684
922
  type: import("../../..").OfferingType;
685
923
  name: string;
@@ -700,11 +938,24 @@ export declare const offeringsContract: {
700
938
  startAt?: string | null | undefined;
701
939
  endAt?: string | null | undefined;
702
940
  cancellationPeriod?: number | null | undefined;
941
+ hasEscrow?: boolean | undefined;
942
+ bankAccountId?: string | null | undefined;
943
+ escrowAccountId?: string | null | undefined;
703
944
  yield?: number | null | undefined;
704
945
  duration?: number | null | undefined;
705
946
  durationType?: import("../../..").DurationType | null | undefined;
706
947
  tiers?: number[] | null | undefined;
707
948
  enableBonus?: boolean | undefined;
949
+ principalAmount?: number | null | undefined;
950
+ maxTotalRaise?: number | null | undefined;
951
+ interestRate?: number | null | undefined;
952
+ interestType?: import("../../../common/types/asset.types").InterestType | null | undefined;
953
+ bonusTiers?: {
954
+ value: number;
955
+ type: import("../../../common/types/bonus-tier.types").BonusType;
956
+ startAmount: number;
957
+ endAmount: number;
958
+ }[] | undefined;
708
959
  }>;
709
960
  summary: "[ADMIN] Create offering";
710
961
  path: "offerings";
package/contracts/clients/trades/index.d.ts CHANGED
@@ -294,7 +294,9 @@ export declare const tradesContract: {
294
294
  offeringId: z.ZodNullable<z.ZodString>;
295
295
  tid: z.ZodNullable<z.ZodString>;
296
296
  investmentType: z.ZodNativeEnum<typeof import("../../..").InvestmentType>;
297
- numberOfShares: z.ZodNumber;
297
+ purchasedShares: z.ZodNumber;
298
+ bonusShares: z.ZodNullable<z.ZodNumber>;
299
+ totalNumberOfShares: z.ZodNumber;
298
300
  pricePerShare: z.ZodNumber;
299
301
  totalAmount: z.ZodNullable<z.ZodNumber>;
300
302
  tradeStatus: z.ZodNativeEnum<typeof import("../../..").TradeStatus>;
@@ -313,7 +315,9 @@ export declare const tradesContract: {
313
315
  investorAccountId: string | null;
314
316
  paymentMethodId: string | null;
315
317
  investmentType: import("../../..").InvestmentType;
316
- numberOfShares: number;
318
+ purchasedShares: number;
319
+ bonusShares: number | null;
320
+ totalNumberOfShares: number;
317
321
  pricePerShare: number;
318
322
  totalAmount: number | null;
319
323
  tradeStatusUnmapped: string | null;
@@ -331,7 +335,9 @@ export declare const tradesContract: {
331
335
  investorAccountId: string | null;
332
336
  paymentMethodId: string | null;
333
337
  investmentType: import("../../..").InvestmentType;
334
- numberOfShares: number;
338
+ purchasedShares: number;
339
+ bonusShares: number | null;
340
+ totalNumberOfShares: number;
335
341
  pricePerShare: number;
336
342
  totalAmount: number | null;
337
343
  tradeStatusUnmapped: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dalmore/api-contracts",
3
- "version": "0.0.0-dev.685c0b3",
3
+ "version": "0.0.0-dev.6f65580",
4
4
  "description": "Type-safe API contracts for Dalmore Client Portal",
5
5
  "type": "module",
6
6
  "main": "./index.js",