@dalmore/api-contracts 0.0.0-dev.74136b1 → 0.0.0-dev.76c0ccc

package/common/types/asset.types.d.ts

@@ -5,6 +5,10 @@ export declare enum AssetTemplateType {
     STANDARD = "STANDARD",
     TIERED = "TIERED"
 }
+export declare enum InterestType {
+    SIMPLE = "SIMPLE",
+    COMPOUND = "COMPOUND"
+}
 export declare const IAsset: z.ZodObject<{
     __entity: z.ZodOptional<z.ZodString>;
     createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
@@ -67,6 +71,10 @@ export declare const IAsset: z.ZodObject<{
     template: z.ZodNativeEnum<typeof AssetTemplateType>;
     tiers: z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>;
     enableBonus: z.ZodBoolean;
+    principalAmount: z.ZodNullable<z.ZodNumber>;
+    maxTotalRaise: z.ZodNullable<z.ZodNumber>;
+    interestRate: z.ZodNullable<z.ZodNumber>;
+    interestType: z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>;
 }, "strip", z.ZodTypeAny, {
     type: AssetType | null;
     id: string;
@@ -85,6 +93,10 @@ export declare const IAsset: z.ZodObject<{
     durationType: DurationType | null;
     tiers: number[] | null;
     enableBonus: boolean;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
     __entity?: string | undefined;
     account?: {
         status: import("./common.types").AccountStatus;
@@ -119,6 +131,10 @@ export declare const IAsset: z.ZodObject<{
     durationType: DurationType | null;
     tiers: number[] | null;
     enableBonus: boolean;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
     __entity?: string | undefined;
     account?: {
         status: import("./common.types").AccountStatus;
@@ -200,6 +216,10 @@ export declare const IPaginatedAsset: z.ZodObject<{
         template: z.ZodNativeEnum<typeof AssetTemplateType>;
         tiers: z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>;
         enableBonus: z.ZodBoolean;
+        principalAmount: z.ZodNullable<z.ZodNumber>;
+        maxTotalRaise: z.ZodNullable<z.ZodNumber>;
+        interestRate: z.ZodNullable<z.ZodNumber>;
+        interestType: z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>;
     }, "strip", z.ZodTypeAny, {
         type: AssetType | null;
         id: string;
@@ -218,6 +238,10 @@ export declare const IPaginatedAsset: z.ZodObject<{
         durationType: DurationType | null;
         tiers: number[] | null;
         enableBonus: boolean;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
         __entity?: string | undefined;
         account?: {
             status: import("./common.types").AccountStatus;
@@ -252,6 +276,10 @@ export declare const IPaginatedAsset: z.ZodObject<{
         durationType: DurationType | null;
         tiers: number[] | null;
         enableBonus: boolean;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
         __entity?: string | undefined;
         account?: {
             status: import("./common.types").AccountStatus;
@@ -307,6 +335,10 @@ export declare const IPaginatedAsset: z.ZodObject<{
         durationType: DurationType | null;
         tiers: number[] | null;
         enableBonus: boolean;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
         __entity?: string | undefined;
         account?: {
             status: import("./common.types").AccountStatus;
@@ -350,6 +382,10 @@ export declare const IPaginatedAsset: z.ZodObject<{
         durationType: DurationType | null;
         tiers: number[] | null;
         enableBonus: boolean;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
         __entity?: string | undefined;
         account?: {
             status: import("./common.types").AccountStatus;
@@ -389,6 +425,10 @@ export declare const PostAsset: z.ZodEffects<z.ZodObject<{
     template: z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>;
     tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
     enableBonus: z.ZodDefault<z.ZodBoolean>;
+    principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
 }, "strip", z.ZodTypeAny, {
     type: AssetType;
     name: string;
@@ -401,6 +441,10 @@ export declare const PostAsset: z.ZodEffects<z.ZodObject<{
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     type: AssetType;
     name: string;
@@ -413,6 +457,10 @@ export declare const PostAsset: z.ZodEffects<z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>, {
     type: AssetType;
     name: string;
@@ -425,6 +473,10 @@ export declare const PostAsset: z.ZodEffects<z.ZodObject<{
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     type: AssetType;
     name: string;
@@ -437,6 +489,10 @@ export declare const PostAsset: z.ZodEffects<z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>;
 export type PostAsset = z.infer<typeof PostAsset>;
 export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
@@ -451,6 +507,10 @@ export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
     template: z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>;
     tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
     enableBonus: z.ZodDefault<z.ZodBoolean>;
+    principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
 } & {
     accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
 }, "strip", z.ZodTypeAny, {
@@ -466,6 +526,10 @@ export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     type: AssetType;
     accountId: string;
@@ -479,6 +543,10 @@ export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>, {
     type: AssetType;
     accountId: string;
@@ -492,6 +560,10 @@ export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     type: AssetType;
     accountId: string;
@@ -505,6 +577,10 @@ export declare const CompliancePostAsset: z.ZodEffects<z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>;
 export type CompliancePostAsset = z.infer<typeof CompliancePostAsset>;
 export declare const PutAsset: z.ZodObject<{
@@ -518,6 +594,10 @@ export declare const PutAsset: z.ZodObject<{
     template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
     tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
     enableBonus: z.ZodOptional<z.ZodBoolean>;
+    principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
 }, "strip", z.ZodTypeAny, {
     type?: AssetType | undefined;
     name?: string | undefined;
@@ -529,6 +609,10 @@ export declare const PutAsset: z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     type?: AssetType | undefined;
     name?: string | undefined;
@@ -540,6 +624,10 @@ export declare const PutAsset: z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>;
 export type PutAsset = z.infer<typeof PutAsset>;
 export declare const CompliancePutAsset: z.ZodObject<{
@@ -553,6 +641,10 @@ export declare const CompliancePutAsset: z.ZodObject<{
     template: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>>>;
     tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
     enableBonus: z.ZodOptional<z.ZodBoolean>;
+    principalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxTotalRaise: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    interestType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>>;
 } & {
     accountId: z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
@@ -567,6 +659,10 @@ export declare const CompliancePutAsset: z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }, {
     accountId: string;
     type?: AssetType | undefined;
@@ -579,6 +675,10 @@ export declare const CompliancePutAsset: z.ZodObject<{
     durationType?: DurationType | null | undefined;
     tiers?: number[] | null | undefined;
     enableBonus?: boolean | undefined;
+    principalAmount?: number | null | undefined;
+    maxTotalRaise?: number | null | undefined;
+    interestRate?: number | null | undefined;
+    interestType?: InterestType | null | undefined;
 }>;
 export type CompliancePutAsset = z.infer<typeof CompliancePutAsset>;
 export declare const AssetsIncludeQuery: z.ZodObject<{
@@ -651,6 +751,87 @@ export declare const StockAssetSchema: z.ZodObject<{
     totalUnits: number | null;
 }>;
 export type StockAssetSchema = z.infer<typeof StockAssetSchema>;
+export declare const PromissoryNoteAssetSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    issuerId: z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+    pricePerUnit: z.ZodNullable<z.ZodNumber>;
+    totalUnits: z.ZodNullable<z.ZodNumber>;
+} & {
+    type: z.ZodLiteral<AssetType.PROMISSORY_NOTE>;
+    principalAmount: z.ZodNullable<z.ZodNumber>;
+    maxTotalRaise: z.ZodNullable<z.ZodNumber>;
+    interestRate: z.ZodNullable<z.ZodNumber>;
+    interestType: z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>;
+}, "strip", z.ZodTypeAny, {
+    type: AssetType.PROMISSORY_NOTE;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
+}, {
+    type: AssetType.PROMISSORY_NOTE;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
+}>;
+export type PromissoryNoteAssetSchema = z.infer<typeof PromissoryNoteAssetSchema>;
+declare const BondAssetSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    issuerId: z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+    pricePerUnit: z.ZodNullable<z.ZodNumber>;
+    totalUnits: z.ZodNullable<z.ZodNumber>;
+} & {
+    type: z.ZodNullable<z.ZodLiteral<AssetType.BOND>>;
+    yield: z.ZodNullable<z.ZodNumber>;
+    duration: z.ZodNullable<z.ZodNumber>;
+    durationType: z.ZodNullable<z.ZodNativeEnum<typeof DurationType>>;
+}, "strip", z.ZodTypeAny, {
+    type: AssetType.BOND | null;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    yield: number | null;
+    duration: number | null;
+    durationType: DurationType | null;
+}, {
+    type: AssetType.BOND | null;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    yield: number | null;
+    duration: number | null;
+    durationType: DurationType | null;
+}>;
+export type BondAssetSchema = z.infer<typeof BondAssetSchema>;
 export declare const AssetSummarySchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -716,6 +897,46 @@ export declare const AssetSummarySchema: z.ZodDiscriminatedUnion<"type", [z.ZodO
     yield: number | null;
     duration: number | null;
     durationType: DurationType | null;
+}>, z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    issuerId: z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+    pricePerUnit: z.ZodNullable<z.ZodNumber>;
+    totalUnits: z.ZodNullable<z.ZodNumber>;
+} & {
+    type: z.ZodLiteral<AssetType.PROMISSORY_NOTE>;
+    principalAmount: z.ZodNullable<z.ZodNumber>;
+    maxTotalRaise: z.ZodNullable<z.ZodNumber>;
+    interestRate: z.ZodNullable<z.ZodNumber>;
+    interestType: z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>;
+}, "strip", z.ZodTypeAny, {
+    type: AssetType.PROMISSORY_NOTE;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
+}, {
+    type: AssetType.PROMISSORY_NOTE;
+    id: string;
+    accountId: string;
+    name: string;
+    offeringId: string;
+    issuerId: string | null;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    principalAmount: number | null;
+    maxTotalRaise: number | null;
+    interestRate: number | null;
+    interestType: InterestType | null;
 }>]>;
 export type AssetSummarySchema = z.infer<typeof AssetSummarySchema>;
 export declare const IPaginatedAssetSummary: z.ZodObject<{
@@ -784,6 +1005,46 @@ export declare const IPaginatedAssetSummary: z.ZodObject<{
         yield: number | null;
         duration: number | null;
         durationType: DurationType | null;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        issuerId: z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+        pricePerUnit: z.ZodNullable<z.ZodNumber>;
+        totalUnits: z.ZodNullable<z.ZodNumber>;
+    } & {
+        type: z.ZodLiteral<AssetType.PROMISSORY_NOTE>;
+        principalAmount: z.ZodNullable<z.ZodNumber>;
+        maxTotalRaise: z.ZodNullable<z.ZodNumber>;
+        interestRate: z.ZodNullable<z.ZodNumber>;
+        interestType: z.ZodNullable<z.ZodNativeEnum<typeof InterestType>>;
+    }, "strip", z.ZodTypeAny, {
+        type: AssetType.PROMISSORY_NOTE;
+        id: string;
+        accountId: string;
+        name: string;
+        offeringId: string;
+        issuerId: string | null;
+        pricePerUnit: number | null;
+        totalUnits: number | null;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
+    }, {
+        type: AssetType.PROMISSORY_NOTE;
+        id: string;
+        accountId: string;
+        name: string;
+        offeringId: string;
+        issuerId: string | null;
+        pricePerUnit: number | null;
+        totalUnits: number | null;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
     }>]>, "many">;
     meta: z.ZodObject<{
         itemCount: z.ZodNumber;
@@ -814,6 +1075,19 @@ export declare const IPaginatedAssetSummary: z.ZodObject<{
         issuerId: string | null;
         pricePerUnit: number | null;
         totalUnits: number | null;
+    } | {
+        type: AssetType.PROMISSORY_NOTE;
+        id: string;
+        accountId: string;
+        name: string;
+        offeringId: string;
+        issuerId: string | null;
+        pricePerUnit: number | null;
+        totalUnits: number | null;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
     } | {
         type: AssetType.BOND | null;
         id: string;
@@ -844,6 +1118,19 @@ export declare const IPaginatedAssetSummary: z.ZodObject<{
         issuerId: string | null;
         pricePerUnit: number | null;
         totalUnits: number | null;
+    } | {
+        type: AssetType.PROMISSORY_NOTE;
+        id: string;
+        accountId: string;
+        name: string;
+        offeringId: string;
+        issuerId: string | null;
+        pricePerUnit: number | null;
+        totalUnits: number | null;
+        principalAmount: number | null;
+        maxTotalRaise: number | null;
+        interestRate: number | null;
+        interestType: InterestType | null;
     } | {
         type: AssetType.BOND | null;
         id: string;
@@ -886,3 +1173,14 @@ export declare const AssetSummaryFiltersZod: z.ZodObject<{
     issuerId?: string | undefined;
 }>;
 export type AssetSummaryFiltersZod = z.infer<typeof AssetSummaryFiltersZod>;
+/**
+ * Maps asset types to fields that should be reset (nullified) when converting
+ * from one asset type to another. This ensures incompatible fields from the
+ * previous type are cleared when the asset type changes.
+ */
+export declare const ASSET_TYPE_FIELD_RESETS: Record<AssetType, Partial<IAsset>>;
+/**
+ * Maps asset types to their required fields when converting TO that asset type.
+ */
+export declare const ASSET_TYPE_REQUIRED_FIELDS: Record<AssetType, Array<keyof IAsset>>;
+export {};