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

package/common/types/issuer-offering.types.d.ts

@@ -1,13 +1,7 @@
 import { z } from 'zod';
-import { OfferingType, ManagedByType, OfferingVersioningType, ComplianceReview, DurationType, AssetType, HttpMethod, WarrantSharesCalculationMethod } from './common.types';
+import { OfferingType, ManagedByType, OfferingVersioningType, ComplianceReview, DurationType, AssetType, HttpMethod, WarrantSharesCalculationMethod, OfferingStatus } from './common.types';
 import { AssetTemplateType } from './asset.types';
 import { PostComplianceOffering } from './offering.types';
-export declare enum OfferingStatus {
-    ONBOARDING = "ONBOARDING",
-    IN_COMPLIANCE_REVIEW = "IN_COMPLIANCE_REVIEW",
-    ACTIVE = "ACTIVE",
-    PAUSED = "PAUSED"
-}
 export declare const IIssuerOffering: z.ZodObject<{
     id: z.ZodString;
     __entity: z.ZodOptional<z.ZodString>;
@@ -339,6 +333,8 @@ export declare const IIssuerOffering: z.ZodObject<{
     calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
     incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    soldOut: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type: OfferingType | null;
     id: string;
@@ -415,6 +411,7 @@ export declare const IIssuerOffering: z.ZodObject<{
         allowPendingComplianceReview: boolean;
         __entity?: string | undefined;
     } | null | undefined;
+    soldOut?: boolean | undefined;
     issuer?: any;
     coverArtId?: string | null | undefined;
     coverArt?: any;
@@ -462,6 +459,7 @@ export declare const IIssuerOffering: z.ZodObject<{
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
     fullyDilutedShares?: number | null | undefined;
+    shareClassId?: string | null | undefined;
 }, {
     type: OfferingType | null;
     id: string;
@@ -538,6 +536,7 @@ export declare const IIssuerOffering: z.ZodObject<{
         allowPendingComplianceReview: boolean;
         __entity?: string | undefined;
     } | null | undefined;
+    soldOut?: boolean | undefined;
     issuer?: any;
     coverArtId?: string | null | undefined;
     coverArt?: any;
@@ -585,6 +584,7 @@ export declare const IIssuerOffering: z.ZodObject<{
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
     fullyDilutedShares?: number | null | undefined;
+    shareClassId?: string | null | undefined;
 }>;
 export type IIssuerOffering = z.infer<typeof IIssuerOffering>;
 export declare const IPaginatedIssuerOffering: z.ZodObject<{
@@ -919,6 +919,8 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
         calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
         incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        shareClassId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        soldOut: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         type: OfferingType | null;
         id: string;
@@ -995,6 +997,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
             allowPendingComplianceReview: boolean;
             __entity?: string | undefined;
         } | null | undefined;
+        soldOut?: boolean | undefined;
         issuer?: any;
         coverArtId?: string | null | undefined;
         coverArt?: any;
@@ -1042,6 +1045,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
         calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
         incrementThreshold?: number | null | undefined;
         fullyDilutedShares?: number | null | undefined;
+        shareClassId?: string | null | undefined;
     }, {
         type: OfferingType | null;
         id: string;
@@ -1118,6 +1122,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
             allowPendingComplianceReview: boolean;
             __entity?: string | undefined;
         } | null | undefined;
+        soldOut?: boolean | undefined;
         issuer?: any;
         coverArtId?: string | null | undefined;
         coverArt?: any;
@@ -1165,6 +1170,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
         calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
         incrementThreshold?: number | null | undefined;
         fullyDilutedShares?: number | null | undefined;
+        shareClassId?: string | null | undefined;
     }>, "many">;
     meta: z.ZodObject<{
         itemCount: z.ZodNumber;
@@ -1262,6 +1268,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
             allowPendingComplianceReview: boolean;
             __entity?: string | undefined;
         } | null | undefined;
+        soldOut?: boolean | undefined;
         issuer?: any;
         coverArtId?: string | null | undefined;
         coverArt?: any;
@@ -1309,6 +1316,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
         calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
         incrementThreshold?: number | null | undefined;
         fullyDilutedShares?: number | null | undefined;
+        shareClassId?: string | null | undefined;
     }[];
     meta: {
         itemCount: number;
@@ -1394,6 +1402,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
             allowPendingComplianceReview: boolean;
             __entity?: string | undefined;
         } | null | undefined;
+        soldOut?: boolean | undefined;
         issuer?: any;
         coverArtId?: string | null | undefined;
         coverArt?: any;
@@ -1441,6 +1450,7 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
         calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
         incrementThreshold?: number | null | undefined;
         fullyDilutedShares?: number | null | undefined;
+        shareClassId?: string | null | undefined;
     }[];
     meta: {
         itemCount: number;
@@ -1452,8 +1462,172 @@ export declare const IPaginatedIssuerOffering: z.ZodObject<{
 }>;
 export type IPaginatedIssuerOffering = z.infer<typeof IPaginatedIssuerOffering>;
 export declare const postOfferingRefinement: (data: PostIssuerOffering | PostComplianceOffering, ctx: z.RefinementCtx) => void;
+export declare const PostIssuerOfferingBaseObject: z.ZodObject<{
+    issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    name: z.ZodString;
+    type: z.ZodNativeEnum<typeof OfferingType>;
+    targetAmount: z.ZodNumber;
+    raiseAmount: z.ZodOptional<z.ZodNumber>;
+    minInvestment: z.ZodOptional<z.ZodNumber>;
+    maxInvestment: z.ZodOptional<z.ZodNumber>;
+    contingencyAmount: z.ZodOptional<z.ZodNumber>;
+    startAt: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+    endAt: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    description: z.ZodLazy<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>>;
+    managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
+    assetName: z.ZodString;
+    assetType: z.ZodNativeEnum<typeof AssetType>;
+    pricePerUnit: z.ZodNullable<z.ZodNumber>;
+    totalUnits: z.ZodNullable<z.ZodNumber>;
+    yield: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    durationType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof DurationType>>>;
+    template: z.ZodDefault<z.ZodNativeEnum<typeof AssetTemplateType>>;
+    tiers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
+    enableBonus: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    hasEscrow: z.ZodOptional<z.ZodBoolean>;
+    bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    interestRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    bonusTiers: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodObject<{
+        type: z.ZodNativeEnum<typeof import("./bonus-tier.types").BonusType>;
+        value: z.ZodEffects<z.ZodNumber, number, number>;
+        startAmount: z.ZodEffects<z.ZodNumber, number, number>;
+        endAmount: z.ZodEffects<z.ZodNumber, number, number>;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }>, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }>, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }, {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }>, "many">>;
+    warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
+    incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type: OfferingType;
+    name: string;
+    template: AssetTemplateType;
+    targetAmount: number;
+    issuerId: string;
+    warrantsEnabled: boolean;
+    assetName: string;
+    assetType: AssetType;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    active?: boolean | undefined;
+    managedBy?: ManagedByType | undefined;
+    description?: string | null | undefined;
+    raiseAmount?: number | undefined;
+    minInvestment?: number | undefined;
+    maxInvestment?: number | undefined;
+    contingencyAmount?: number | undefined;
+    startAt?: Date | null | undefined;
+    endAt?: Date | null | undefined;
+    cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
+    hasEscrow?: boolean | undefined;
+    bankAccountId?: string | null | undefined;
+    escrowAccountId?: string | null | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
+    yield?: number | null | undefined;
+    duration?: number | null | undefined;
+    durationType?: DurationType | null | undefined;
+    tiers?: number[] | null | undefined;
+    enableBonus?: boolean | undefined;
+    interestRate?: number | null | undefined;
+    bonusTiers?: {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }[] | undefined;
+}, {
+    type: OfferingType;
+    name: string;
+    targetAmount: number;
+    issuerId: string;
+    assetName: string;
+    assetType: AssetType;
+    pricePerUnit: number | null;
+    totalUnits: number | null;
+    active?: boolean | undefined;
+    managedBy?: ManagedByType | undefined;
+    description?: string | null | undefined;
+    template?: AssetTemplateType | undefined;
+    raiseAmount?: number | undefined;
+    minInvestment?: number | undefined;
+    maxInvestment?: number | undefined;
+    contingencyAmount?: number | undefined;
+    startAt?: string | null | undefined;
+    endAt?: string | null | undefined;
+    cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
+    hasEscrow?: boolean | undefined;
+    bankAccountId?: string | null | undefined;
+    escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
+    yield?: number | null | undefined;
+    duration?: number | null | undefined;
+    durationType?: DurationType | null | undefined;
+    tiers?: number[] | null | undefined;
+    enableBonus?: boolean | undefined;
+    interestRate?: number | null | undefined;
+    bonusTiers?: {
+        value: number;
+        type: import("./bonus-tier.types").BonusType;
+        startAmount: number;
+        endAmount: number;
+    }[] | undefined;
+}>;
 export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     name: z.ZodString;
     type: z.ZodNativeEnum<typeof OfferingType>;
     targetAmount: z.ZodNumber;
@@ -1465,7 +1639,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     endAt: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
     active: z.ZodOptional<z.ZodBoolean>;
     cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-    description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    description: z.ZodLazy<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>>;
     managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
     assetName: z.ZodString;
     assetType: z.ZodNativeEnum<typeof AssetType>;
@@ -1524,6 +1698,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
     calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
     incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
     type: OfferingType;
     name: string;
@@ -1545,6 +1720,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     startAt?: Date | null | undefined;
     endAt?: Date | null | undefined;
     cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
@@ -1554,6 +1730,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -1586,6 +1763,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     startAt?: string | null | undefined;
     endAt?: string | null | undefined;
     cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
@@ -1596,6 +1774,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -1629,6 +1808,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     startAt?: Date | null | undefined;
     endAt?: Date | null | undefined;
     cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
@@ -1638,6 +1818,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -1670,6 +1851,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     startAt?: string | null | undefined;
     endAt?: string | null | undefined;
     cancellationPeriod?: number | null | undefined;
+    showTotalRaised?: boolean | undefined;
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
@@ -1680,6 +1862,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -1695,6 +1878,7 @@ export declare const PostIssuerOffering: z.ZodEffects<z.ZodObject<{
 }>;
 export type PostIssuerOffering = z.infer<typeof PostIssuerOffering>;
 export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     name: z.ZodOptional<z.ZodString>;
     type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
     targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -1704,7 +1888,7 @@ export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
     startAt: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
     endAt: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
     cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-    description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    description: z.ZodLazy<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>>;
     memorandumId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     subscriptionAgreementId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     coverArtId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
@@ -1798,6 +1982,7 @@ export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1843,6 +2028,7 @@ export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1888,6 +2074,7 @@ export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1933,6 +2120,7 @@ export declare const PatchIssuerOffering: z.ZodEffects<z.ZodObject<{
     warrantPercentage?: number | null | undefined;
     calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
     incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -2004,10 +2192,10 @@ export declare const IssuerOfferingsFilterZod: z.ZodObject<{
     issuerId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
     type: z.ZodOptional<z.ZodNativeEnum<typeof OfferingType>>;
     status: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
+    complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
     enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
     managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
     versioningType: z.ZodOptional<z.ZodNativeEnum<typeof OfferingVersioningType>>;
-    combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof OfferingStatus>>;
     sortByNameASC: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>, boolean, unknown>;
 }, "strip", z.ZodTypeAny, {
     sortByNameASC: boolean;
@@ -2016,22 +2204,22 @@ export declare const IssuerOfferingsFilterZod: z.ZodObject<{
     accountId?: string | undefined;
     name?: string | undefined;
     managedBy?: ManagedByType | undefined;
+    complianceReview?: ComplianceReview | undefined;
     enabled?: boolean | undefined;
     issuerId?: string | undefined;
     issuerName?: string | undefined;
     versioningType?: OfferingVersioningType | undefined;
-    combinedStatus?: OfferingStatus | undefined;
 }, {
     type?: OfferingType | undefined;
     status?: ComplianceReview | undefined;
     accountId?: string | undefined;
     name?: string | undefined;
     managedBy?: ManagedByType | undefined;
+    complianceReview?: ComplianceReview | undefined;
     enabled?: unknown;
     issuerId?: string | undefined;
     issuerName?: string | undefined;
     versioningType?: OfferingVersioningType | undefined;
-    combinedStatus?: OfferingStatus | undefined;
     sortByNameASC?: unknown;
 }>;
 export type IssuerOfferingsFilterZod = z.infer<typeof IssuerOfferingsFilterZod>;

package/common/types/issuer-offering.types.js

@@ -1,6 +1,6 @@
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
-import { AccountZod, dateSchema, IPaginationMeta, OfferingType, ManagedByType, OfferingVersioningType, ComplianceReview, DurationType, AssetType, StringToBooleanSchema, HttpMethod, numberPrecisionSchema, WarrantSharesCalculationMethod, } from './common.types.js';
+import { AccountZod, dateSchema, IPaginationMeta, OfferingType, ManagedByType, OfferingVersioningType, ComplianceReview, DurationType, AssetType, StringToBooleanSchema, HttpMethod, numberPrecisionSchema, WarrantSharesCalculationMethod, OfferingStatus, } from './common.types.js';
 import { IBaseEntity } from './entity.types.js';
 import { IIssuer, issuerIdSchema } from './issuer.types.js';
 import { IAsset, postAssetRefinement, AssetTemplateType } from './asset.types.js';
@@ -9,14 +9,9 @@ import { accountIdSchema } from './account.types.js';
 import { IIssuerBankAccount, issuerBankAccountIdSchema, } from './issuer-bank-account.types.js';
 import { escrowAccountIdSchema, IEscrowAccount } from './escrow-account.types.js';
 import { BonusTierListZod, postBonusTierRefinement } from './bonus-tier.types.js';
+import { OfferingDescriptionZod, } from './offering.types.js';
+import { capShareClassIdSchema } from './cap-table.types.js';
 extendZodWithOpenApi(z);
-export var OfferingStatus;
-(function (OfferingStatus) {
-    OfferingStatus["ONBOARDING"] = "ONBOARDING";
-    OfferingStatus["IN_COMPLIANCE_REVIEW"] = "IN_COMPLIANCE_REVIEW";
-    OfferingStatus["ACTIVE"] = "ACTIVE";
-    OfferingStatus["PAUSED"] = "PAUSED";
-})(OfferingStatus || (OfferingStatus = {}));
 export const IIssuerOffering = IBaseEntity.extend({
     name: z.string(),
     tid: z.string().nullable(),
@@ -84,6 +79,8 @@ export const IIssuerOffering = IBaseEntity.extend({
         .optional(),
     incrementThreshold: z.number().nullable().optional(),
     fullyDilutedShares: z.number().nullable().optional(),
+    shareClassId: z.string().nullable().optional(),
+    soldOut: z.boolean().optional(),
 });
 export const IPaginatedIssuerOffering = z.object({
     items: z.array(IIssuerOffering),
@@ -93,7 +90,6 @@ export const postOfferingRefinement = (data, ctx) => {
     if (data.minInvestment && data.maxInvestment) {
         if (data.minInvestment >= data.maxInvestment) {
             ctx.addIssue({
-                path: ['minInvestment'],
                 message: 'Minimum investment must be less than maximum investment.',
                 code: z.ZodIssueCode.custom,
             });
@@ -111,16 +107,29 @@ export const postOfferingRefinement = (data, ctx) => {
         data.targetAmount &&
         data.targetAmount < data.maxInvestment) {
         ctx.addIssue({
-            path: ['maxInvestment'],
             message: 'Maximum investment must be less than target amount.',
             code: z.ZodIssueCode.custom,
         });
     }
+    if (data.type === OfferingType.REG_CF) {
+        if (data.contingencyAmount === null ||
+            data.contingencyAmount === undefined ||
+            (typeof data.contingencyAmount === 'number' && data.contingencyAmount <= 0)) {
+            ctx.addIssue({
+                message: 'Contingency amount is required for REG_CF offerings.',
+                code: z.ZodIssueCode.custom,
+            });
+        }
+    }
 };
-export const PostIssuerOffering = z
-    .object({
+export const PostIssuerOfferingBaseObject = z.object({
     issuerId: z.lazy(() => issuerIdSchema),
-    name: z.string().min(2).max(100).openapi({ example: 'Airbnb IPO' }),
+    shareClassId: z
+        .lazy(() => capShareClassIdSchema)
+        .nullable()
+        .optional()
+        .openapi({ example: 'cap_table_share_class_01j1xgme...' }),
+    name: z.string().min(2).max(150).openapi({ example: 'Airbnb IPO' }),
     type: z.nativeEnum(OfferingType).openapi({ example: OfferingType.REG_D }),
     targetAmount: z
         .number()
@@ -161,13 +170,7 @@ export const PostIssuerOffering = z
         .openapi({ example: 4 })
         .optional()
         .nullable(),
-    description: z
-        .string()
-        .min(1)
-        .max(5000)
-        .optional()
-        .nullable()
-        .openapi({ example: 'This is a description of the offering.' }),
+    description: z.lazy(() => OfferingDescriptionZod),
     managedBy: z.nativeEnum(ManagedByType).optional(),
     assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
     assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
@@ -263,8 +266,9 @@ export const PostIssuerOffering = z
         .nullable()
         .optional()
         .openapi({ example: 10 }),
-})
-    .superRefine((data, ctx) => {
+    showTotalRaised: z.boolean().default(true).optional(),
+});
+export const PostIssuerOffering = PostIssuerOfferingBaseObject.superRefine((data, ctx) => {
     postOfferingRefinement(data, ctx);
     postAssetRefinement(data, ctx);
     escrowValidationRefinement(data, ctx, HttpMethod.POST);
@@ -273,10 +277,15 @@ export const PostIssuerOffering = z
 });
 export const PatchIssuerOffering = z
     .object({
+    shareClassId: z
+        .lazy(() => capShareClassIdSchema)
+        .nullable()
+        .optional()
+        .openapi({ example: 'cap_table_share_class_01j1xgme...' }),
     name: z
         .string()
         .min(2)
-        .max(100)
+        .max(150, { message: 'Name must be 150 characters or less' })
         .optional()
         .openapi({ example: 'Airbnb IPO' }),
     type: z
@@ -322,13 +331,7 @@ export const PatchIssuerOffering = z
         .optional()
         .openapi({ example: 4 })
         .nullable(),
-    description: z
-        .string()
-        .min(1)
-        .max(5000)
-        .optional()
-        .nullable()
-        .openapi({ example: 'This is a description of the offering.' }),
+    description: z.lazy(() => OfferingDescriptionZod),
     memorandumId: z
         .lazy(() => fileIdSchema)
         .optional()
@@ -447,6 +450,16 @@ export const PatchIssuerOffering = z
         .openapi({ example: 10 }),
 })
     .superRefine((data, ctx) => {
+    if (data.type === OfferingType.REG_CF) {
+        if (data.contingencyAmount === null ||
+            data.contingencyAmount === undefined ||
+            (typeof data.contingencyAmount === 'number' && data.contingencyAmount <= 0)) {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: 'Contingency amount is required for REG_CF offerings.',
+            });
+        }
+    }
     // Apply escrow-specific refinements
     escrowValidationRefinement(data, ctx, HttpMethod.PATCH);
     // Apply bonus-tier-specific refinements
@@ -463,6 +476,7 @@ const issuerOfferingsInclude = z.enum([
     'onboardingReviewedBy',
     'bankAccount',
     'escrowAccount',
+    'shareClass',
 ]);
 /**
  * @description Query parameters for including related entities
@@ -499,10 +513,10 @@ export const IssuerOfferingsFilterZod = z.object({
     issuerId: z.lazy(() => issuerIdSchema).optional(),
     type: z.nativeEnum(OfferingType).optional(),
     status: z.nativeEnum(ComplianceReview).optional(),
+    complianceReview: z.nativeEnum(ComplianceReview).optional(),
     enabled: StringToBooleanSchema.optional(),
     managedBy: z.nativeEnum(ManagedByType).optional(),
     versioningType: z.nativeEnum(OfferingVersioningType).optional(),
-    combinedStatus: z.nativeEnum(OfferingStatus).optional(),
     sortByNameASC: z.preprocess((val) => val === 'true' || val === '1'
         ? true
         : val === 'false' || val === '0'