@dalmore/api-contracts 0.0.0-dev.d2fe663 → 0.0.0-dev.d38f1ff

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 (82) 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 +27 -24
  8. package/common/types/activity.types.js +6 -0
  9. package/common/types/activity.types.js.map +1 -1
  10. package/common/types/asset.types.d.ts +212 -0
  11. package/common/types/asset.types.js +115 -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 +128 -25
  17. package/common/types/bonus-tier.types.js +48 -12
  18. package/common/types/bonus-tier.types.js.map +1 -1
  19. package/common/types/cap-table.types.d.ts +1124 -0
  20. package/common/types/cap-table.types.js +406 -0
  21. package/common/types/cap-table.types.js.map +1 -0
  22. package/common/types/common.types.d.ts +30 -3
  23. package/common/types/common.types.js +18 -0
  24. package/common/types/common.types.js.map +1 -1
  25. package/common/types/comply-advantage-api.types.d.ts +133 -466
  26. package/common/types/comply-advantage-api.types.js +24 -3
  27. package/common/types/comply-advantage-api.types.js.map +1 -1
  28. package/common/types/dashboard.types.d.ts +7 -7
  29. package/common/types/data-record.types.d.ts +4 -4
  30. package/common/types/disbursements.types.d.ts +613 -392
  31. package/common/types/disbursements.types.js +37 -0
  32. package/common/types/disbursements.types.js.map +1 -1
  33. package/common/types/escrow-account.types.d.ts +17 -0
  34. package/common/types/escrow-account.types.js +3 -0
  35. package/common/types/escrow-account.types.js.map +1 -1
  36. package/common/types/file.types.d.ts +14 -11
  37. package/common/types/file.types.js +2 -0
  38. package/common/types/file.types.js.map +1 -1
  39. package/common/types/index.d.ts +2 -0
  40. package/common/types/index.js +2 -0
  41. package/common/types/index.js.map +1 -1
  42. package/common/types/individuals.types.js +5 -2
  43. package/common/types/individuals.types.js.map +1 -1
  44. package/common/types/investor-account.types.d.ts +4 -4
  45. package/common/types/issuer-bank-account.types.d.ts +4 -276
  46. package/common/types/issuer-offering.types.d.ts +662 -5
  47. package/common/types/issuer-offering.types.js +100 -6
  48. package/common/types/issuer-offering.types.js.map +1 -1
  49. package/common/types/job-item.types.d.ts +14 -14
  50. package/common/types/note.types.d.ts +15 -15
  51. package/common/types/offering-submission.types.js +2 -2
  52. package/common/types/offering.types.d.ts +281 -1
  53. package/common/types/offering.types.js +109 -10
  54. package/common/types/offering.types.js.map +1 -1
  55. package/common/types/portfolio.types.d.ts +6 -6
  56. package/common/types/reports.types.d.ts +345 -0
  57. package/common/types/reports.types.js +69 -0
  58. package/common/types/reports.types.js.map +1 -0
  59. package/common/types/signer.types.d.ts +23 -11
  60. package/common/types/signer.types.js +16 -1
  61. package/common/types/signer.types.js.map +1 -1
  62. package/common/types/site.types.d.ts +5 -0
  63. package/common/types/task.types.d.ts +22 -22
  64. package/common/types/trade-line-item.types.d.ts +18 -1
  65. package/common/types/trade-line-item.types.js +12 -1
  66. package/common/types/trade-line-item.types.js.map +1 -1
  67. package/common/types/trade.types.d.ts +64 -45
  68. package/common/types/trade.types.js +13 -4
  69. package/common/types/trade.types.js.map +1 -1
  70. package/common/types/transaction.types.d.ts +80 -1
  71. package/common/types/transaction.types.js +22 -2
  72. package/common/types/transaction.types.js.map +1 -1
  73. package/common/types/user.types.d.ts +34 -0
  74. package/common/types/user.types.js +4 -0
  75. package/common/types/user.types.js.map +1 -1
  76. package/contracts/clients/assets/index.d.ts +22 -0
  77. package/contracts/clients/files/index.d.ts +3 -3
  78. package/contracts/clients/files-public/index.d.ts +3 -3
  79. package/contracts/clients/index.d.ts +257 -13
  80. package/contracts/clients/offerings/index.d.ts +220 -4
  81. package/contracts/clients/trades/index.d.ts +9 -3
  82. 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,50 @@ 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
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
447
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
448
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
449
+ value: z.ZodEffects<z.ZodNumber, number, number>;
450
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
451
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
452
+ }, "strip", z.ZodTypeAny, {
453
+ value: number;
454
+ type: import("../../../common/types/bonus-tier.types").BonusType;
455
+ startAmount: number;
456
+ endAmount: number;
457
+ }, {
458
+ value: number;
459
+ type: import("../../../common/types/bonus-tier.types").BonusType;
460
+ startAmount: number;
461
+ endAmount: number;
462
+ }>, {
463
+ value: number;
464
+ type: import("../../../common/types/bonus-tier.types").BonusType;
465
+ startAmount: number;
466
+ endAmount: number;
467
+ }, {
468
+ value: number;
469
+ type: import("../../../common/types/bonus-tier.types").BonusType;
470
+ startAmount: number;
471
+ endAmount: number;
472
+ }>, {
473
+ value: number;
474
+ type: import("../../../common/types/bonus-tier.types").BonusType;
475
+ startAmount: number;
476
+ endAmount: number;
477
+ }, {
478
+ value: number;
479
+ type: import("../../../common/types/bonus-tier.types").BonusType;
480
+ startAmount: number;
481
+ endAmount: number;
482
+ }>, "many">>;
443
483
  }, "strip", z.ZodTypeAny, {
444
484
  type?: import("../../..").OfferingType | undefined;
445
485
  name?: string | undefined;
446
- managedBy?: import("../../..").ManagedByType | undefined;
447
486
  description?: string | null | undefined;
448
487
  enabled?: boolean | undefined;
449
488
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -459,6 +498,10 @@ export declare const offeringsContract: {
459
498
  memorandumId?: string | null | undefined;
460
499
  subscriptionAgreementId?: string | null | undefined;
461
500
  showTotalRaised?: boolean | undefined;
501
+ hasEscrow?: boolean | undefined;
502
+ escrowAgreementFileId?: string | null | undefined;
503
+ bankAccountId?: string | null | undefined;
504
+ escrowAccountId?: string | null | undefined;
462
505
  assetName?: string | undefined;
463
506
  assetType?: import("../../..").AssetType | undefined;
464
507
  pricePerUnit?: number | null | undefined;
@@ -468,10 +511,16 @@ export declare const offeringsContract: {
468
511
  durationType?: import("../../..").DurationType | null | undefined;
469
512
  tiers?: number[] | null | undefined;
470
513
  enableBonus?: boolean | undefined;
514
+ interestRate?: number | null | undefined;
515
+ bonusTiers?: {
516
+ value: number;
517
+ type: import("../../../common/types/bonus-tier.types").BonusType;
518
+ startAmount: number;
519
+ endAmount: number;
520
+ }[] | undefined;
471
521
  }, {
472
522
  type?: import("../../..").OfferingType | undefined;
473
523
  name?: string | undefined;
474
- managedBy?: import("../../..").ManagedByType | undefined;
475
524
  description?: string | null | undefined;
476
525
  enabled?: boolean | undefined;
477
526
  template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
@@ -487,6 +536,86 @@ export declare const offeringsContract: {
487
536
  memorandumId?: string | null | undefined;
488
537
  subscriptionAgreementId?: string | null | undefined;
489
538
  showTotalRaised?: boolean | undefined;
539
+ hasEscrow?: boolean | undefined;
540
+ escrowAgreementFileId?: string | null | undefined;
541
+ bankAccountId?: string | null | undefined;
542
+ escrowAccountId?: string | null | undefined;
543
+ assetName?: string | undefined;
544
+ assetType?: import("../../..").AssetType | undefined;
545
+ pricePerUnit?: number | null | undefined;
546
+ totalUnits?: number | null | undefined;
547
+ yield?: number | null | undefined;
548
+ duration?: number | null | undefined;
549
+ durationType?: import("../../..").DurationType | null | undefined;
550
+ tiers?: number[] | null | undefined;
551
+ enableBonus?: boolean | undefined;
552
+ interestRate?: number | null | undefined;
553
+ bonusTiers?: {
554
+ value: number;
555
+ type: import("../../../common/types/bonus-tier.types").BonusType;
556
+ startAmount: number;
557
+ endAmount: number;
558
+ }[] | undefined;
559
+ }>, {
560
+ type?: import("../../..").OfferingType | undefined;
561
+ name?: string | undefined;
562
+ description?: string | null | undefined;
563
+ enabled?: boolean | undefined;
564
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
565
+ coverArtId?: string | null | undefined;
566
+ targetAmount?: number | undefined;
567
+ minInvestment?: number | null | undefined;
568
+ maxInvestment?: number | null | undefined;
569
+ contingencyAmount?: number | null | undefined;
570
+ startAt?: Date | null | undefined;
571
+ endAt?: Date | null | undefined;
572
+ issuerId?: string | undefined;
573
+ cancellationPeriod?: number | null | undefined;
574
+ memorandumId?: string | null | undefined;
575
+ subscriptionAgreementId?: string | null | undefined;
576
+ showTotalRaised?: boolean | undefined;
577
+ hasEscrow?: boolean | undefined;
578
+ escrowAgreementFileId?: string | null | undefined;
579
+ bankAccountId?: string | null | undefined;
580
+ escrowAccountId?: string | null | undefined;
581
+ assetName?: string | undefined;
582
+ assetType?: import("../../..").AssetType | undefined;
583
+ pricePerUnit?: number | null | undefined;
584
+ totalUnits?: number | null | undefined;
585
+ yield?: number | null | undefined;
586
+ duration?: number | null | undefined;
587
+ durationType?: import("../../..").DurationType | null | undefined;
588
+ tiers?: number[] | null | undefined;
589
+ enableBonus?: boolean | undefined;
590
+ interestRate?: number | null | undefined;
591
+ bonusTiers?: {
592
+ value: number;
593
+ type: import("../../../common/types/bonus-tier.types").BonusType;
594
+ startAmount: number;
595
+ endAmount: number;
596
+ }[] | undefined;
597
+ }, {
598
+ type?: import("../../..").OfferingType | undefined;
599
+ name?: string | undefined;
600
+ description?: string | null | undefined;
601
+ enabled?: boolean | undefined;
602
+ template?: import("../../../common/types/asset.types").AssetTemplateType | null | undefined;
603
+ coverArtId?: string | null | undefined;
604
+ targetAmount?: number | undefined;
605
+ minInvestment?: number | null | undefined;
606
+ maxInvestment?: number | null | undefined;
607
+ contingencyAmount?: number | null | undefined;
608
+ startAt?: string | null | undefined;
609
+ endAt?: string | null | undefined;
610
+ issuerId?: string | undefined;
611
+ cancellationPeriod?: number | null | undefined;
612
+ memorandumId?: string | null | undefined;
613
+ subscriptionAgreementId?: string | null | undefined;
614
+ showTotalRaised?: boolean | undefined;
615
+ hasEscrow?: boolean | undefined;
616
+ escrowAgreementFileId?: string | null | undefined;
617
+ bankAccountId?: string | null | undefined;
618
+ escrowAccountId?: string | null | undefined;
490
619
  assetName?: string | undefined;
491
620
  assetType?: import("../../..").AssetType | undefined;
492
621
  pricePerUnit?: number | null | undefined;
@@ -496,6 +625,13 @@ export declare const offeringsContract: {
496
625
  durationType?: import("../../..").DurationType | null | undefined;
497
626
  tiers?: number[] | null | undefined;
498
627
  enableBonus?: boolean | undefined;
628
+ interestRate?: number | null | undefined;
629
+ bonusTiers?: {
630
+ value: number;
631
+ type: import("../../../common/types/bonus-tier.types").BonusType;
632
+ startAmount: number;
633
+ endAmount: number;
634
+ }[] | undefined;
499
635
  }>;
500
636
  pathParams: z.ZodObject<{
501
637
  id: z.ZodEffects<z.ZodString, string, string>;
@@ -605,6 +741,46 @@ export declare const offeringsContract: {
605
741
  template: z.ZodDefault<z.ZodNativeEnum<typeof import("../../../common/types/asset.types").AssetTemplateType>>;
606
742
  tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
607
743
  enableBonus: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
744
+ hasEscrow: z.ZodOptional<z.ZodBoolean>;
745
+ bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
746
+ escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
747
+ interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
748
+ bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
749
+ type: z.ZodNativeEnum<typeof import("../../../common/types/bonus-tier.types").BonusType>;
750
+ value: z.ZodEffects<z.ZodNumber, number, number>;
751
+ startAmount: z.ZodEffects<z.ZodNumber, number, number>;
752
+ endAmount: z.ZodEffects<z.ZodNumber, number, number>;
753
+ }, "strip", z.ZodTypeAny, {
754
+ value: number;
755
+ type: import("../../../common/types/bonus-tier.types").BonusType;
756
+ startAmount: number;
757
+ endAmount: number;
758
+ }, {
759
+ value: number;
760
+ type: import("../../../common/types/bonus-tier.types").BonusType;
761
+ startAmount: number;
762
+ endAmount: number;
763
+ }>, {
764
+ value: number;
765
+ type: import("../../../common/types/bonus-tier.types").BonusType;
766
+ startAmount: number;
767
+ endAmount: number;
768
+ }, {
769
+ value: number;
770
+ type: import("../../../common/types/bonus-tier.types").BonusType;
771
+ startAmount: number;
772
+ endAmount: number;
773
+ }>, {
774
+ value: number;
775
+ type: import("../../../common/types/bonus-tier.types").BonusType;
776
+ startAmount: number;
777
+ endAmount: number;
778
+ }, {
779
+ value: number;
780
+ type: import("../../../common/types/bonus-tier.types").BonusType;
781
+ startAmount: number;
782
+ endAmount: number;
783
+ }>, "many">>;
608
784
  }, "strip", z.ZodTypeAny, {
609
785
  type: import("../../..").OfferingType;
610
786
  name: string;
@@ -625,11 +801,21 @@ export declare const offeringsContract: {
625
801
  startAt?: Date | null | undefined;
626
802
  endAt?: Date | null | undefined;
627
803
  cancellationPeriod?: number | null | undefined;
804
+ hasEscrow?: boolean | undefined;
805
+ bankAccountId?: string | null | undefined;
806
+ escrowAccountId?: string | null | undefined;
628
807
  yield?: number | null | undefined;
629
808
  duration?: number | null | undefined;
630
809
  durationType?: import("../../..").DurationType | null | undefined;
631
810
  tiers?: number[] | null | undefined;
632
811
  enableBonus?: boolean | undefined;
812
+ interestRate?: number | null | undefined;
813
+ bonusTiers?: {
814
+ value: number;
815
+ type: import("../../../common/types/bonus-tier.types").BonusType;
816
+ startAmount: number;
817
+ endAmount: number;
818
+ }[] | undefined;
633
819
  }, {
634
820
  type: import("../../..").OfferingType;
635
821
  name: string;
@@ -650,11 +836,21 @@ export declare const offeringsContract: {
650
836
  startAt?: string | null | undefined;
651
837
  endAt?: string | null | undefined;
652
838
  cancellationPeriod?: number | null | undefined;
839
+ hasEscrow?: boolean | undefined;
840
+ bankAccountId?: string | null | undefined;
841
+ escrowAccountId?: string | null | undefined;
653
842
  yield?: number | null | undefined;
654
843
  duration?: number | null | undefined;
655
844
  durationType?: import("../../..").DurationType | null | undefined;
656
845
  tiers?: number[] | null | undefined;
657
846
  enableBonus?: boolean | undefined;
847
+ interestRate?: number | null | undefined;
848
+ bonusTiers?: {
849
+ value: number;
850
+ type: import("../../../common/types/bonus-tier.types").BonusType;
851
+ startAmount: number;
852
+ endAmount: number;
853
+ }[] | undefined;
658
854
  }>, {
659
855
  type: import("../../..").OfferingType;
660
856
  name: string;
@@ -675,11 +871,21 @@ export declare const offeringsContract: {
675
871
  startAt?: Date | null | undefined;
676
872
  endAt?: Date | null | undefined;
677
873
  cancellationPeriod?: number | null | undefined;
874
+ hasEscrow?: boolean | undefined;
875
+ bankAccountId?: string | null | undefined;
876
+ escrowAccountId?: string | null | undefined;
678
877
  yield?: number | null | undefined;
679
878
  duration?: number | null | undefined;
680
879
  durationType?: import("../../..").DurationType | null | undefined;
681
880
  tiers?: number[] | null | undefined;
682
881
  enableBonus?: boolean | undefined;
882
+ interestRate?: number | null | undefined;
883
+ bonusTiers?: {
884
+ value: number;
885
+ type: import("../../../common/types/bonus-tier.types").BonusType;
886
+ startAmount: number;
887
+ endAmount: number;
888
+ }[] | undefined;
683
889
  }, {
684
890
  type: import("../../..").OfferingType;
685
891
  name: string;
@@ -700,11 +906,21 @@ export declare const offeringsContract: {
700
906
  startAt?: string | null | undefined;
701
907
  endAt?: string | null | undefined;
702
908
  cancellationPeriod?: number | null | undefined;
909
+ hasEscrow?: boolean | undefined;
910
+ bankAccountId?: string | null | undefined;
911
+ escrowAccountId?: string | null | undefined;
703
912
  yield?: number | null | undefined;
704
913
  duration?: number | null | undefined;
705
914
  durationType?: import("../../..").DurationType | null | undefined;
706
915
  tiers?: number[] | null | undefined;
707
916
  enableBonus?: boolean | undefined;
917
+ interestRate?: number | null | undefined;
918
+ bonusTiers?: {
919
+ value: number;
920
+ type: import("../../../common/types/bonus-tier.types").BonusType;
921
+ startAmount: number;
922
+ endAmount: number;
923
+ }[] | undefined;
708
924
  }>;
709
925
  summary: "[ADMIN] Create offering";
710
926
  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.d2fe663",
3
+ "version": "0.0.0-dev.d38f1ff",
4
4
  "description": "Type-safe API contracts for Dalmore Client Portal",
5
5
  "type": "module",
6
6
  "main": "./index.js",